-
Notifications
You must be signed in to change notification settings - Fork 0
Add AGENTS.md with Cursor Cloud development instructions #37
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | ||||||
| # AGENTS.md | ||||||
|
|
||||||
| ## Cursor Cloud specific instructions | ||||||
|
|
||||||
| ### Overview | ||||||
|
|
||||||
| **Forge (DevForge)** is a self-hosted autonomous software development dashboard built with **Astro 6 SSR** + **Preact** + **Tailwind CSS / DaisyUI**. The UI and codebase are in French. | ||||||
|
|
||||||
| ### Stack | ||||||
|
|
||||||
| - **Framework:** Astro 6 (SSR mode, `output: 'server'`) | ||||||
| - **UI Components:** Preact (`.tsx` interactive islands) | ||||||
| - **Styling:** Tailwind CSS 3 + DaisyUI (custom `forge` theme) | ||||||
| - **Database:** Astro DB (local SQLite via libSQL, auto-created at `.astro/db.sqlite`) | ||||||
| - **Runtime:** Node.js >= 22.12.0 | ||||||
| - **Package manager:** npm (lockfile: `package-lock.json`, `.npmrc` sets `legacy-peer-deps=true`) | ||||||
|
|
||||||
| ### Key commands | ||||||
|
|
||||||
| | Action | Command | | ||||||
| |--------|---------| | ||||||
| | Install deps | `npm install` | | ||||||
| | Dev server | `npm run dev` (serves on `http://localhost:4321`) | | ||||||
| | Build | `npm run build` | | ||||||
| | Preview | `npm run preview` | | ||||||
|
|
||||||
| ### Development notes | ||||||
|
|
||||||
| - **No ESLint/Prettier/test framework** is configured in this repo. The build (`npm run build`) is the primary correctness check. | ||||||
| - `astro check` may hang in constrained environments; the build is a more reliable validation step. | ||||||
| - The dev server auto-creates the SQLite database and seeds it on first run. No manual DB setup is needed. | ||||||
| - The app redirects unauthenticated users to `/login`. Register via the "Créer un compte" tab (min 10-char password). After registration, the setup wizard at `/setup` can be skipped. | ||||||
| - **OpenClaw** and **Ollama** are optional external services. The dashboard gracefully degrades when they are unreachable. | ||||||
| - The Docker-related API endpoint (`/api/docker.ts`) gracefully returns empty data when Docker is unavailable. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is a discrepancy between this documentation and the implementation in
Suggested change
|
||||||
| - `scripts/run-astro.mjs` wraps the Astro CLI and auto-sets `ASTRO_DATABASE_FILE` if not provided. | ||||||
| - `scripts/ensure-win32-natives.cjs` is a no-op on Linux (exits immediately on non-Windows). | ||||||
| - `scripts/patch-astro-node-polyfill.cjs` patches a compatibility shim for `@astrojs/node`; it runs automatically via npm lifecycle hooks. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The absence of ESLint, Prettier, and a testing framework is a significant maintainability risk.\n\nWhile documenting this state is helpful for agents, it highlights a major gap in the project's quality assurance. Relying solely on the build process for correctness checks can lead to regressions and inconsistent code style. It is highly recommended to integrate these tools to automate quality checks and ensure long-term project health.