create-einja-app 0.2.9 → 0.2.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -7
- package/dist/cli.js +879 -14
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
- package/templates/default/AGENTS.md +52 -0
package/package.json
CHANGED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Repository Guidelines
|
|
2
|
+
|
|
3
|
+
## Project Structure & Module Organization
|
|
4
|
+
- `apps/web/` hosts the main Next.js 15 admin app (App Router in `apps/web/src/app/`).
|
|
5
|
+
- Shared packages live under `packages/`:
|
|
6
|
+
- `packages/ui/` for shared UI components (shadcn/ui).
|
|
7
|
+
- `packages/front-core/` for shared frontend auth/hooks/utils.
|
|
8
|
+
- `packages/server-core/` for Prisma schema and backend utilities.
|
|
9
|
+
- `packages/config/` for shared Biome/TS/Panda configs.
|
|
10
|
+
- Database schema lives in `packages/server-core/prisma/`.
|
|
11
|
+
- Scripts live in `scripts/`, logs in `log/`, docs in `docs/`.
|
|
12
|
+
- Worktree dev auto-assigns ports per branch; check `.env.local` for `PORT`.
|
|
13
|
+
|
|
14
|
+
## Build, Test, and Development Commands
|
|
15
|
+
- `pnpm dev:setup`: initial setup (.env creation, DB start/init).
|
|
16
|
+
- `pnpm dev:bg`: run dev servers in the background (logs at `log/dev.log`).
|
|
17
|
+
- `pnpm dev:status` / `pnpm dev:logs` / `pnpm dev:stop`: manage background dev servers.
|
|
18
|
+
- `pnpm build` / `pnpm start`: production build and run.
|
|
19
|
+
- `pnpm lint` / `pnpm format` / `pnpm typecheck`: Biome + TypeScript checks.
|
|
20
|
+
- `pnpm test` / `pnpm test:watch` / `pnpm test:coverage`: Vitest runs.
|
|
21
|
+
- `pnpm db:generate` / `pnpm db:push` / `pnpm db:migrate`: Prisma client and migrations.
|
|
22
|
+
|
|
23
|
+
## Coding Style & Naming Conventions
|
|
24
|
+
- TypeScript strict mode; keep types explicit at module boundaries.
|
|
25
|
+
- Biome formatting: 2-space indentation and double quotes.
|
|
26
|
+
- Panda CSS generates styles into `apps/web/src/styled-system/` (do not hand-edit).
|
|
27
|
+
- Import patterns: app-local uses `@/...`, shared uses `@repo/...`.
|
|
28
|
+
|
|
29
|
+
## Testing Guidelines
|
|
30
|
+
- Unit/integration tests use Vitest + React Testing Library.
|
|
31
|
+
- E2E coverage uses Playwright (Chromium).
|
|
32
|
+
- Prefer colocated tests near source; use `*.test.ts` / `*.test.tsx` naming.
|
|
33
|
+
- Run the minimal scope first (`pnpm --filter @repo/web test`) before full suite.
|
|
34
|
+
- Test expectations and scope are defined in `docs/einja/steering/development/testing-strategy.md` (read before adding new suites).
|
|
35
|
+
|
|
36
|
+
## Commit & Pull Request Guidelines
|
|
37
|
+
- Commit history follows Conventional Commits: `feat:`, `fix:`, `chore(scope):`.
|
|
38
|
+
- Use clear scopes when relevant (e.g., `feat(cli): ...`).
|
|
39
|
+
- PRs should include: summary, test evidence, and screenshots for UI changes.
|
|
40
|
+
- Link related issues and call out any migrations or env changes.
|
|
41
|
+
- Commit rules live in `docs/einja/steering/commit-rules.md` (keep prefixes and scopes consistent).
|
|
42
|
+
- Review expectations are in `docs/einja/steering/development/review-guidelines.md` (use the checklist before requesting review).
|
|
43
|
+
|
|
44
|
+
## Architecture & Workflow References
|
|
45
|
+
- Branch naming and lifecycle rules: `docs/einja/steering/branch-strategy.md`.
|
|
46
|
+
- Day-to-day dev flow and checkpoints: `docs/einja/steering/development-workflow.md`.
|
|
47
|
+
- System overview and major boundaries: `docs/einja/steering/architecture.md`.
|
|
48
|
+
- Environment variable policy and storage: `docs/einja/steering/infrastructure/environment-variables.md`.
|
|
49
|
+
|
|
50
|
+
## Security & Configuration Tips
|
|
51
|
+
- Manage env files via `pnpm env:update`; encrypted secrets require `.env.keys`.
|
|
52
|
+
- Local DB runs via `docker-compose up -d postgres` (port `25432`).
|