Skip to content

docs: add repository guidelines #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BikerViking merged 1 commit into from
Aug 27, 2025
Merged

docs: add repository guidelines #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AGENTS

## Coding Conventions
- Use TypeScript and modern ECMAScript.
- Follow the existing ESLint configurations. Run `npm run lint` in any package you modify.
- Format code with Prettier (default settings; see `.prettierignore`).
- Target Node.js 18+ (see `.nvmrc`).

## Lint & Test Commands
- **Client**: `cd client && npm run lint`
- **Server**: `cd server && npm run lint`
- **Server tests**: `cd server && npm test`

## Environment Setup
- Install Node.js 18 and run `nvm use` to switch versions.
- Run `npm install` inside both `client/` and `server/` to install dependencies.
- For the API server, copy `server/.env.example` to `server/.env` and fill in required credentials.
- Development uses two terminals:
- `cd server && npm run dev` (http://localhost:8787)
- `cd client && npm run dev` (http://localhost:5173)