Initial project scaffold and agent docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
vader
2026-05-23 11:16:12 +01:00
commit b820b69ce6
8 changed files with 254 additions and 0 deletions
+69
View File
@@ -0,0 +1,69 @@
# FinanceOne
Personal finance web application — budgets, accounts, transactions, and reporting.
## Stack (planned)
| Layer | Choice |
|-------|--------|
| Runtime | Node.js 20+ |
| Framework | Next.js (App Router) |
| Language | TypeScript |
| Styling | Tailwind CSS |
| Package manager | npm |
Adjust this table when the scaffold is generated or the stack changes.
## Prerequisites
- Node.js 20 or later
- npm 10+
## Getting started
The application scaffold is not generated yet. After `package.json` exists:
```bash
npm install
cp .env.example .env.local # fill values locally; never commit secrets
npm run dev
```
Open [http://localhost:3000](http://localhost:3000).
## Scripts
| Command | Purpose |
|---------|---------|
| `npm run dev` | Local development server |
| `npm run build` | Production build |
| `npm run start` | Run production build |
| `npm run lint` | ESLint |
| `npm test` | Unit / integration tests |
Scripts appear in `package.json` once the app is scaffolded.
## Environment variables
See [.env.example](.env.example). Copy to `.env.local` for local development.
## Project layout (target)
```
financeOne/
├── src/ # application source (after scaffold)
├── public/
├── .cursor/rules/ # Cursor agent guardrails
├── AGENTS.md # agent workflow and conventions
└── README.md
```
## Cursor / agents
- Read [AGENTS.md](AGENTS.md) first: concise replies, ask when unclear, then conventions and verify steps.
- Rules: `.cursor/rules/`. Chat starter: `.cursor/chat-context-template.md`.
- Verify: `npm run lint` and `npm test` when available.
## License
Private / unlicensed unless stated otherwise.