admin/pos-system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add AGENTS.md with Cursor Cloud development instructions

Browse Source 
Co-authored-by: Velik <hongochai10@users.noreply.github.com>
This commit is contained in:
Cursor Agent
2026-02-26 14:59:01 +00:00
parent e3954ed708
commit a2abc08011
1 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
AGENTS.md Normal file
View File

@@ -0,0 +1,35 @@
# AGENTS.md
## Cursor Cloud specific instructions
### Project overview
GoodGo is an enterprise microservices monorepo. The Node.js/TypeScript layer (frontend apps + shared packages) is the primary development target in this cloud environment. Backend services are all .NET 10 and require external infrastructure (Neon PostgreSQL, Redis, Docker) that is not available by default.
### Runtime requirements
- **Node.js 25** (specified in `.nvmrc` and `package.json` engines). Install via `nvm install 25 && nvm alias default 25`.
- **pnpm 8.15.0** (specified in `package.json` `packageManager` field). Install via `npm install -g pnpm@8.15.0`.
### Key commands
Standard commands are documented in `README.md` and `package.json` scripts. Quick reference:
| Task | Command |
|------|---------|
| Install deps | `pnpm install` |
| Build shared packages | `pnpm -r --filter "./packages/*" build` |
| Lint | `pnpm lint` |
| Typecheck | `pnpm typecheck` |
| Test | `pnpm test` |
| Dev (web-client) | `pnpm --filter @goodgo/web-client dev` |
| Dev (docs) | `pnpm --filter @goodgo/vitepress-docs dev` |
| Format | `pnpm format` |
### Gotchas
- **Shared packages must be built before typecheck/dev**: `pnpm typecheck` automatically builds packages first (see the script in root `package.json`), but if running `pnpm --filter @goodgo/web-client dev` directly, ensure packages are built first with `pnpm -r --filter "./packages/*" build`.
- **Prisma warning on Node 25**: Prisma emits a preinstall warning that Node 25 is not officially supported. This is non-blocking; `pnpm install` completes successfully.
- **Pre-existing test failures**: 6 tests in `apps/web-client` fail due to Zustand persist middleware requiring `localStorage` which is not properly mocked in the jsdom test environment. These are pre-existing and not caused by environment setup. The failing stores are `auth-store` and `chat-store`.
- **Backend services (.NET)**: All services under `services/*-net/` require .NET 10 SDK, Neon PostgreSQL, and Redis. They are not runnable in the default cloud environment without those dependencies.
- **web-client dev server**: Runs on port 3000 by default via `next dev`.