From 6c068383e5ee75909d2d78cf7155f77def7ae7e2 Mon Sep 17 00:00:00 2001 From: BikerViking <160994481+BikerViking@users.noreply.github.com> Date: Wed, 27 Aug 2025 10:59:31 -0400 Subject: [PATCH] docs: add repository guidelines --- AGENTS.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..1b20867 --- /dev/null +++ b/AGENTS.md @@ -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)