@next-friday/create-app 2.1.6 → 2.1.8

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 CHANGED
@@ -65,7 +65,7 @@ The name must:
65
65
  ## What the CLI does
66
66
 
67
67
  1. Copies the template into the project directory and replaces the template's package name with the project name.
68
- 2. Writes `.env` from `.env.example`. For Payload, it sets `PAYLOAD_SECRET` to a random secret.
68
+ 2. Writes `.env` from `.env.example`. For Payload and Turborepo, it sets `PAYLOAD_SECRET` to a random secret.
69
69
  3. Runs `git init --initial-branch=main`, unless the directory is already in a Git repository.
70
70
  4. Runs `pnpm install`, which also installs the Git hooks.
71
71
  5. Prints the next steps, for example:
@@ -75,7 +75,7 @@ The name must:
75
75
  pnpm start:dev
76
76
  ```
77
77
 
78
- The development script is `pnpm dev` for Next.js and Payload, and `pnpm start:dev` for Node.js and NestJS.
78
+ The development script is `pnpm dev` for Next.js, Payload, and Turborepo, and `pnpm start:dev` for Node.js and NestJS.
79
79
 
80
80
  Then follow **After creating a project from this template** in the project's `README.md` to make the first commit and set up the repository.
81
81
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@next-friday/create-app",
3
- "version": "2.1.6",
3
+ "version": "2.1.8",
4
4
  "description": "Create a Next Friday project from a template.",
5
5
  "keywords": [
6
6
  "create",
@@ -49,7 +49,7 @@
49
49
  ]
50
50
  },
51
51
  {
52
- "matcher": "Bash",
52
+ "matcher": "Bash|PowerShell|Monitor",
53
53
  "hooks": [
54
54
  {
55
55
  "type": "command",
@@ -33,6 +33,7 @@ concurrency:
33
33
  jobs:
34
34
  verify:
35
35
  name: Verify the requested commit
36
+ if: github.ref == 'refs/heads/main'
36
37
  runs-on: ubuntu-latest
37
38
  timeout-minutes: 5
38
39
  permissions:
@@ -66,13 +67,14 @@ jobs:
66
67
  prod)
67
68
  previous=uat
68
69
  export EXPECTED_TITLE="Deploy $COMMIT_SHA to uat"
69
- deployed="$(gh api --paginate "repos/$REPOSITORY/actions/workflows/deploy.yml/runs?event=workflow_dispatch&status=success&per_page=100" --jq '.workflow_runs[] | select(.display_title == env.EXPECTED_TITLE) | .id' | wc -l)"
70
+ deployed="$(gh api --paginate "repos/$REPOSITORY/actions/workflows/deploy.yml/runs?event=workflow_dispatch&status=success&branch=main&per_page=100" --jq '.workflow_runs[] | select(.display_title == env.EXPECTED_TITLE) | .id' | wc -l)"
70
71
  ;;
71
72
  esac
72
73
  [[ "$deployed" -gt 0 ]] || { echo "::error::$COMMIT_SHA has no successful $previous deployment; promote through $previous first"; exit 1; }
73
74
 
74
75
  deploy:
75
76
  name: Deploy to ${{ inputs.environment }}
77
+ if: github.ref == 'refs/heads/main'
76
78
  needs: verify
77
79
  runs-on: ubuntu-latest
78
80
  timeout-minutes: 30
@@ -1,7 +1,36 @@
1
1
  # Agent guide
2
2
 
3
- NestJS service on pnpm. Source lives in `src/`, end-to-end tests in `test/`.
3
+ NestJS HTTP API in TypeScript on pnpm and Node.js `>=24.15.0 <25`.
4
4
 
5
- - Follow the rules in `.agents/rules/`; `.agents/rules.json` gives each rule's scope. Claude Code and Cursor load them automatically.
6
- - Put unit tests next to the code as `*.test.ts`; put end-to-end tests in `test/` as `*.e2e.test.ts`.
7
- - Read configuration from environment variables and fail when one is missing; document each variable in `.env.example`.
5
+ ## Commands
6
+
7
+ | Task | Command |
8
+ | :-------------------------- | :-------------------------------------------------- |
9
+ | Start with reload | `pnpm start:dev` |
10
+ | One test | `pnpm vitest run src/port.test.ts -t "<test name>"` |
11
+ | Unit tests | `pnpm test`, or `pnpm test:coverage` |
12
+ | End-to-end tests | `pnpm test:e2e` |
13
+ | What `pre-push` runs | `pnpm check` |
14
+ | Every check | `pnpm verify` |
15
+ | Render rules after a change | `pnpm rules:sync` |
16
+
17
+ ## How it fits together
18
+
19
+ - `src/main.ts` creates the app from `AppModule` on `parsePort(process.env.PORT)` with Nest's `ConsoleLogger`, which writes JSON lines when `NODE_ENV` is `production`.
20
+ - `AppModule` imports `HealthModule`, whose Terminus controller serves `/health`. Add a feature as its own module and import it in `AppModule`.
21
+
22
+ ## Mandatory rules
23
+
24
+ 1. **Follow `.agents/rules/`.** `.agents/rules.json` gives each rule's scope; Claude Code and Cursor load them. After changing either, run `pnpm rules:sync`; `pnpm check` fails on stale copies.
25
+ 2. **Put unit tests next to the code as `src/**/*.test.ts` and end-to-end tests in `test/` as `*.e2e.test.ts`.** `vitest.config.ts` and `vitest.e2e.config.ts` collect only those patterns.
26
+ 3. **Read configuration from environment variables and fail when one is missing**, as `parsePort` does. Document each variable in `.env.example`.
27
+ 4. **Log through Nest's `Logger`.** It goes to the `ConsoleLogger` set in `src/main.ts`.
28
+
29
+ ## Known pitfalls
30
+
31
+ - **Agent shell gate**: `.agents/hooks/agent-shell-gate.sh` blocks a shell command that writes to a protected path such as `.agents`, `.cursor`, `.claude/rules`, or `.husky`. It is a convenience, not a security boundary: CI and code-owner review are the boundary.
32
+
33
+ ## Related documentation
34
+
35
+ - [README.md](README.md): scripts, container, deploy
36
+ - [CONTRIBUTING.md](CONTRIBUTING.md): prerequisites, Git hooks, pull requests
@@ -68,7 +68,7 @@ On Vercel, the zero-configuration NestJS preset takes precedence over the `Docke
68
68
  - the `RAILWAY_SERVICE` variable: the service name;
69
69
  - the `APP_URL` variable: the public `https://` URL.
70
70
 
71
- Limit `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
71
+ Limit `dev`, `uat`, and `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
72
72
 
73
73
  3. Set the repository variable `DEPLOY_ENABLED` to `true`. Each push to `main` that passes CI then deploys to `dev`.
74
74
  4. Promote with **Actions → Deploy → Run workflow**, giving the environment and the full commit SHA. The workflow requires a successful CI run on `main` for that commit and a successful deployment to the previous environment, then waits for `/health`.
@@ -1,10 +1,40 @@
1
1
  # Agent guide
2
2
 
3
- Next.js App Router application on pnpm. Routes live in `app/`.
3
+ Next.js App Router web app with React and Tailwind CSS, in TypeScript on pnpm and Node.js `>=24.15.0 <25`.
4
4
 
5
- - Follow the rules in `.agents/rules/`; `.agents/rules.json` gives each rule's scope. Claude Code and Cursor load them automatically.
6
- - Put unit tests next to the code as `*.test.ts`; put Playwright end-to-end tests in `test/` as `*.e2e.test.ts`. Component tests need a DOM test environment, which is not set up yet; ask the user before adding one.
7
- - Read configuration from environment variables and fail when one is missing; document each variable in `.env.example`.
5
+ ## Commands
6
+
7
+ | Task | Command |
8
+ | :-------------------------- | :---------------------------------------------------------- |
9
+ | Start with reload | `pnpm dev` |
10
+ | One test | `pnpm vitest run app/health/route.test.ts -t "<test name>"` |
11
+ | Unit tests | `pnpm test`, or `pnpm test:coverage` |
12
+ | End-to-end tests | `pnpm test:e2e` |
13
+ | What `pre-push` runs | `pnpm check` |
14
+ | Every check | `pnpm verify` |
15
+ | Render rules after a change | `pnpm rules:sync` |
16
+
17
+ ## How it fits together
18
+
19
+ - Routes live in `app/`. `app/health/route.ts` serves `/health`.
20
+ - `next.config.ts` builds `output: "standalone"`, enables Cache Components, and sets the security headers. `pnpm start` copies the static assets into `.next/standalone` and serves it.
21
+
22
+ ## Mandatory rules
23
+
24
+ 1. **Follow `.agents/rules/`.** `.agents/rules.json` gives each rule's scope; Claude Code and Cursor load them. After changing either, run `pnpm rules:sync`; `pnpm check` fails on stale copies.
25
+ 2. **Put unit tests next to the code as `app/**/*.test.{ts,tsx}` and Playwright end-to-end tests in `test/` as `*.e2e.test.ts`.** Vitest collects only the first pattern.
26
+ 3. **Ask the user before adding component tests.** They need a DOM test environment, and Vitest runs in Node.js.
27
+ 4. **Read configuration from environment variables and fail when one is missing.** Document each variable in `.env.example`.
28
+
29
+ ## Known pitfalls
30
+
31
+ - **First end-to-end run**: run `pnpm exec playwright install chromium` once. `pnpm test:e2e` starts the development server unless one is already running.
32
+ - **Agent shell gate**: `.agents/hooks/agent-shell-gate.sh` blocks a shell command that writes to a protected path such as `.agents`, `.cursor`, `.claude/rules`, or `.husky`. It is a convenience, not a security boundary: CI and code-owner review are the boundary.
33
+
34
+ ## Related documentation
35
+
36
+ - [README.md](README.md): scripts, container, deploy
37
+ - [CONTRIBUTING.md](CONTRIBUTING.md): prerequisites, Git hooks, pull requests
8
38
 
9
39
  <!-- BEGIN:nextjs-agent-rules -->
10
40
 
@@ -64,7 +64,7 @@ On Vercel, deploy without the image; the Next.js preset takes precedence over th
64
64
  - the `RAILWAY_SERVICE` variable: the service name;
65
65
  - the `APP_URL` variable: the public `https://` URL.
66
66
 
67
- Limit `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
67
+ Limit `dev`, `uat`, and `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
68
68
 
69
69
  3. Set the repository variable `DEPLOY_ENABLED` to `true`. Each push to `main` that passes CI then deploys to `dev`.
70
70
  4. Promote with **Actions → Deploy → Run workflow**, giving the environment and the full commit SHA. The workflow requires a successful CI run on `main` for that commit and a successful deployment to the previous environment, then waits for `/health`.
@@ -1,7 +1,34 @@
1
1
  # Agent guide
2
2
 
3
- Node.js HTTP service on pnpm, without a framework. Source lives in `src/`.
3
+ TypeScript HTTP service on `node:http`, without a framework, on pnpm and Node.js `>=24.15.0 <25`.
4
4
 
5
- - Follow the rules in `.agents/rules/`; `.agents/rules.json` gives each rule's scope. Claude Code and Cursor load them automatically.
6
- - Put tests next to the code as `*.test.ts`.
7
- - Read configuration from environment variables and fail when one is missing; document each variable in `.env.example`.
5
+ ## Commands
6
+
7
+ | Task | Command |
8
+ | :-------------------------- | :-------------------------------------------------- |
9
+ | Start with reload | `pnpm start:dev` |
10
+ | One test | `pnpm vitest run src/port.test.ts -t "<test name>"` |
11
+ | Unit tests | `pnpm test`, or `pnpm test:coverage` |
12
+ | What `pre-push` runs | `pnpm check` |
13
+ | Every check | `pnpm verify` |
14
+ | Render rules after a change | `pnpm rules:sync` |
15
+
16
+ ## How it fits together
17
+
18
+ - `src/main.ts` starts `createAppServer()` from `src/server.ts` on `parsePort(process.env.PORT)`, and on `SIGTERM` or `SIGINT` stops accepting connections and closes any left after 10 seconds.
19
+ - `src/server.ts` answers `GET` and `HEAD` `/health` and returns 404 for every other request. Routes go there.
20
+
21
+ ## Mandatory rules
22
+
23
+ 1. **Follow `.agents/rules/`.** `.agents/rules.json` gives each rule's scope; Claude Code and Cursor load them. After changing either, run `pnpm rules:sync`; `pnpm check` fails on stale copies.
24
+ 2. **Put tests next to the code as `src/**/*.test.ts`.** Vitest collects only that pattern.
25
+ 3. **Read configuration from environment variables and fail when one is missing**, as `parsePort` does. Document each variable in `.env.example`; `pnpm start` and `pnpm start:dev` load `.env`.
26
+
27
+ ## Known pitfalls
28
+
29
+ - **Agent shell gate**: `.agents/hooks/agent-shell-gate.sh` blocks a shell command that writes to a protected path such as `.agents`, `.cursor`, `.claude/rules`, or `.husky`. It is a convenience, not a security boundary: CI and code-owner review are the boundary.
30
+
31
+ ## Related documentation
32
+
33
+ - [README.md](README.md): scripts, container, deploy
34
+ - [CONTRIBUTING.md](CONTRIBUTING.md): prerequisites, Git hooks, pull requests
@@ -64,7 +64,7 @@ docker run --env PORT=3000 --publish 3000:3000 app
64
64
  - the `RAILWAY_SERVICE` variable: the service name;
65
65
  - the `APP_URL` variable: the public `https://` URL.
66
66
 
67
- Limit `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
67
+ Limit `dev`, `uat`, and `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
68
68
 
69
69
  3. Set the repository variable `DEPLOY_ENABLED` to `true`. Each push to `main` that passes CI then deploys to `dev`.
70
70
  4. Promote with **Actions → Deploy → Run workflow**, giving the environment and the full commit SHA. The workflow requires a successful CI run on `main` for that commit and a successful deployment to the previous environment, then waits for `/health`.
@@ -1,11 +1,43 @@
1
1
  # Agent guide
2
2
 
3
- Payload CMS on Next.js App Router and PostgreSQL, on pnpm. Source lives in `src/`: the site in `src/app/(frontend)/`, collections in `src/collections/`, and the Payload config in `src/payload.config.ts`.
3
+ Payload CMS on Next.js App Router and PostgreSQL, in TypeScript on pnpm and Node.js `>=24.22.1 <25`. The API is REST at `/api`.
4
4
 
5
- - Follow the rules in `.agents/rules/`; `.agents/rules.json` gives each rule's scope. Claude Code and Cursor load them automatically.
6
- - Put unit tests next to the code as `*.test.ts`; put Playwright end-to-end tests in `test/` as `*.e2e.test.ts`. Component tests need a DOM test environment, which is not set up yet; ask the user before adding one.
7
- - Payload generates `src/app/(payload)/`, `src/payload-types.ts`, and `src/migrations/`. After changing a collection, regenerate them with `pnpm generate:types`, `pnpm generate:importmap`, and `pnpm migrate:create <name>`, and commit the results.
8
- - Read configuration through `requireEnvironment` in `src/environment.ts`; document each variable in `.env.example`.
5
+ ## Commands
6
+
7
+ | Task | Command |
8
+ | :---------------------------- | :--------------------------------------------------------- |
9
+ | Start with reload | `pnpm dev` |
10
+ | One test | `pnpm vitest run src/environment.test.ts -t "<test name>"` |
11
+ | Unit tests | `pnpm test`, or `pnpm test:coverage` |
12
+ | End-to-end tests | `pnpm test:e2e` |
13
+ | Regenerate after a collection | `pnpm generate:types`, `pnpm generate:importmap` |
14
+ | Create a migration | `pnpm migrate:create <name>` |
15
+ | What `pre-push` runs | `pnpm check` |
16
+ | Every check | `pnpm verify` |
17
+ | Render rules after a change | `pnpm rules:sync` |
18
+
19
+ ## How it fits together
20
+
21
+ - `src/payload.config.ts` wires the collections in `src/collections/` to PostgreSQL. The site lives in `src/app/(frontend)/`, and `src/app/health/route.ts` serves `/health`.
22
+ - In development, Payload applies collection changes to the database directly. In production, the server applies the migrations in `src/migrations/` when it starts.
23
+
24
+ ## Mandatory rules
25
+
26
+ 1. **Follow `.agents/rules/`.** `.agents/rules.json` gives each rule's scope; Claude Code and Cursor load them. After changing either, run `pnpm rules:sync`; `pnpm check` fails on stale copies.
27
+ 2. **Change the schema only through collections, then regenerate and commit.** Payload generates `src/app/(payload)/`, `src/payload-types.ts`, and `src/migrations/`; run `pnpm generate:types`, `pnpm generate:importmap`, and `pnpm migrate:create <name>`. Do not edit those files by hand.
28
+ 3. **Put unit tests next to the code as `src/**/*.test.{ts,tsx}` and Playwright end-to-end tests in `test/` as `*.e2e.test.ts`.** Vitest collects only the first pattern.
29
+ 4. **Ask the user before adding component tests.** They need a DOM test environment, and Vitest runs in Node.js.
30
+ 5. **Read configuration through `requireEnvironment` in `src/environment.ts`.** Document each variable in `.env.example`.
31
+
32
+ ## Known pitfalls
33
+
34
+ - **Database for `pnpm dev` and end-to-end tests**: both need a PostgreSQL database in `DATABASE_URL` and `PAYLOAD_SECRET` in `.env`; the README lists every variable. Run `pnpm exec playwright install chromium` once before the first `pnpm test:e2e`.
35
+ - **Agent shell gate**: `.agents/hooks/agent-shell-gate.sh` blocks a shell command that writes to a protected path such as `.agents`, `.cursor`, `.claude/rules`, or `.husky`. It is a convenience, not a security boundary: CI and code-owner review are the boundary.
36
+
37
+ ## Related documentation
38
+
39
+ - [README.md](README.md): environment variables, scripts, container, deploy
40
+ - [CONTRIBUTING.md](CONTRIBUTING.md): prerequisites, Git hooks, pull requests
9
41
 
10
42
  <!-- BEGIN:nextjs-agent-rules -->
11
43
 
@@ -88,7 +88,7 @@ On Vercel, deploy without the image; the Next.js preset takes precedence over th
88
88
  - the `RAILWAY_SERVICE` variable: the service name;
89
89
  - the `APP_URL` variable: the public `https://` URL.
90
90
 
91
- Limit `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
91
+ Limit `dev`, `uat`, and `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
92
92
 
93
93
  3. Set the repository variable `DEPLOY_ENABLED` to `true`. Each push to `main` that passes CI then deploys to `dev`.
94
94
  4. Promote with **Actions → Deploy → Run workflow**, giving the environment and the full commit SHA. The workflow requires a successful CI run on `main` for that commit and a successful deployment to the previous environment, then waits for `/health`.
@@ -214,37 +214,46 @@ jobs:
214
214
  done
215
215
  } >> "$GITHUB_OUTPUT"
216
216
  - name: Lint Dockerfile
217
+ env:
218
+ AFFECTED_APP: ${{ steps.affected.outputs.app }}
219
+ AFFECTED_BACKOFFICE: ${{ steps.affected.outputs.backoffice }}
217
220
  run: |
218
221
  curl --silent --show-error --fail --location --output hadolint \
219
222
  "https://github.com/hadolint/hadolint/releases/download/v${HADOLINT_VERSION}/hadolint-linux-x86_64"
220
223
  echo "${HADOLINT_SHA256} hadolint" | sha256sum --check --strict
221
224
  chmod +x hadolint
222
225
  files=()
223
- if [[ "${{ steps.affected.outputs.app }}" == "true" ]]; then
226
+ if [[ "$AFFECTED_APP" == "true" ]]; then
224
227
  files+=(apps/app/Dockerfile)
225
228
  fi
226
- if [[ "${{ steps.affected.outputs.backoffice }}" == "true" ]]; then
229
+ if [[ "$AFFECTED_BACKOFFICE" == "true" ]]; then
227
230
  files+=(apps/backoffice/Dockerfile)
228
231
  fi
229
232
  if [[ "${#files[@]}" -gt 0 ]]; then
230
233
  ./hadolint "${files[@]}"
231
234
  fi
232
235
  - name: Build images
236
+ env:
237
+ AFFECTED_APP: ${{ steps.affected.outputs.app }}
238
+ AFFECTED_BACKOFFICE: ${{ steps.affected.outputs.backoffice }}
233
239
  run: |
234
- if [[ "${{ steps.affected.outputs.app }}" == "true" ]]; then
240
+ if [[ "$AFFECTED_APP" == "true" ]]; then
235
241
  docker build --file apps/app/Dockerfile --tag app:ci .
236
242
  fi
237
- if [[ "${{ steps.affected.outputs.backoffice }}" == "true" ]]; then
243
+ if [[ "$AFFECTED_BACKOFFICE" == "true" ]]; then
238
244
  docker build --file apps/backoffice/Dockerfile --tag backoffice:ci .
239
245
  fi
240
246
  - name: Smoke test images
247
+ env:
248
+ AFFECTED_APP: ${{ steps.affected.outputs.app }}
249
+ AFFECTED_BACKOFFICE: ${{ steps.affected.outputs.backoffice }}
241
250
  id: smoke
242
251
  run: |
243
- if [[ "${{ steps.affected.outputs.app }}" == "true" ]]; then
252
+ if [[ "$AFFECTED_APP" == "true" ]]; then
244
253
  docker run --detach --name app --env PORT=3000 --publish 3000:3000 app:ci
245
254
  curl --silent --show-error --fail --retry 15 --retry-delay 1 --retry-all-errors --output /dev/null http://localhost:3000/health
246
255
  fi
247
- if [[ "${{ steps.affected.outputs.backoffice }}" == "true" ]]; then
256
+ if [[ "$AFFECTED_BACKOFFICE" == "true" ]]; then
248
257
  docker run --detach --name backoffice --env PORT=3001 --env DATABASE_URL=postgres://build-only@localhost/build-only --env PAYLOAD_SECRET=ci-only-secret --env APP_URL=http://localhost:3001 --publish 3001:3001 backoffice:ci
249
258
  curl --silent --show-error --fail --retry 15 --retry-delay 1 --retry-all-errors --output /dev/null http://localhost:3001/health
250
259
  fi
@@ -258,16 +267,19 @@ jobs:
258
267
  docker logs backoffice
259
268
  fi
260
269
  - name: Scan images for vulnerabilities
270
+ env:
271
+ AFFECTED_APP: ${{ steps.affected.outputs.app }}
272
+ AFFECTED_BACKOFFICE: ${{ steps.affected.outputs.backoffice }}
261
273
  run: |
262
274
  archive="trivy_${TRIVY_VERSION}_Linux-64bit.tar.gz"
263
275
  curl --silent --show-error --fail --location --output "$archive" \
264
276
  "https://github.com/aquasecurity/trivy/releases/download/v${TRIVY_VERSION}/${archive}"
265
277
  echo "${TRIVY_SHA256} ${archive}" | sha256sum --check --strict
266
278
  tar --extract --gzip --file "$archive" trivy
267
- if [[ "${{ steps.affected.outputs.app }}" == "true" ]]; then
279
+ if [[ "$AFFECTED_APP" == "true" ]]; then
268
280
  ./trivy image --exit-code 1 --severity HIGH,CRITICAL --ignore-unfixed --no-progress app:ci
269
281
  fi
270
- if [[ "${{ steps.affected.outputs.backoffice }}" == "true" ]]; then
282
+ if [[ "$AFFECTED_BACKOFFICE" == "true" ]]; then
271
283
  ./trivy image --exit-code 1 --severity HIGH,CRITICAL --ignore-unfixed --no-progress backoffice:ci
272
284
  fi
273
285
 
@@ -33,6 +33,7 @@ concurrency:
33
33
  jobs:
34
34
  verify:
35
35
  name: Verify the requested commit
36
+ if: github.ref == 'refs/heads/main'
36
37
  runs-on: ubuntu-latest
37
38
  timeout-minutes: 5
38
39
  permissions:
@@ -66,13 +67,14 @@ jobs:
66
67
  prod)
67
68
  previous=uat
68
69
  export EXPECTED_TITLE="Deploy $COMMIT_SHA to uat"
69
- deployed="$(gh api --paginate "repos/$REPOSITORY/actions/workflows/deploy.yml/runs?event=workflow_dispatch&status=success&per_page=100" --jq '.workflow_runs[] | select(.display_title == env.EXPECTED_TITLE) | .id' | wc -l)"
70
+ deployed="$(gh api --paginate "repos/$REPOSITORY/actions/workflows/deploy.yml/runs?event=workflow_dispatch&status=success&branch=main&per_page=100" --jq '.workflow_runs[] | select(.display_title == env.EXPECTED_TITLE) | .id' | wc -l)"
70
71
  ;;
71
72
  esac
72
73
  [[ "$deployed" -gt 0 ]] || { echo "::error::$COMMIT_SHA has no successful $previous deployment; promote through $previous first"; exit 1; }
73
74
 
74
75
  deploy:
75
76
  name: Deploy to ${{ inputs.environment }}
77
+ if: github.ref == 'refs/heads/main'
76
78
  needs: verify
77
79
  runs-on: ubuntu-latest
78
80
  timeout-minutes: 40
@@ -134,7 +136,7 @@ jobs:
134
136
  latest="$completed"
135
137
  previous="$candidate"
136
138
  fi
137
- done < <(gh api --paginate "repos/$REPOSITORY/actions/workflows/deploy.yml/runs?status=success&per_page=50" --jq '.workflow_runs[] | [.id, .display_title] | @tsv')
139
+ done < <(gh api --paginate "repos/$REPOSITORY/actions/workflows/deploy.yml/runs?status=success&branch=main&per_page=50" --jq '.workflow_runs[] | [.id, .display_title] | @tsv')
138
140
  while IFS=$'\t' read -r run_id head_sha; do
139
141
  [[ -z "$run_id" || "$head_sha" == "$COMMIT_SHA" ]] && continue
140
142
  completed="$(gh api "repos/$REPOSITORY/actions/runs/$run_id/jobs" | jq -r --arg env "$RAILWAY_ENVIRONMENT" '[.jobs[] | select(.conclusion == "success" and .name == "Deploy to \($env) / Deploy to \($env)") | .completed_at] | max // empty')"
@@ -1,19 +1,43 @@
1
1
  # Agent guide
2
2
 
3
- Turborepo workspace on pnpm. `apps/app` is the Next.js site. `apps/backoffice` is the Payload CMS. Root scripts run the same checks as the other Next Friday templates and delegate framework commands with Turborepo.
3
+ Turborepo workspace in TypeScript on pnpm and Node.js `>=24.22.1 <25`. `apps/app` is a Next.js site on port 3000. `apps/backoffice` is a Payload CMS on PostgreSQL on port 3001, with a REST API at `/api`.
4
4
 
5
- - Follow the rules in `.agents/rules/`; `.agents/rules.json` gives each rule's scope. Claude Code and Cursor load them automatically.
6
- - Put unit tests next to the code as `*.test.ts`. Put Playwright end-to-end tests in `apps/app/test/` and `apps/backoffice/test/` as `*.e2e.test.ts`. Component tests need a DOM test environment, which is not set up yet; ask the user before adding one.
7
- - The Next.js site lives in `apps/app/app/`. The backoffice site lives in `apps/backoffice/src/app/(frontend)/`, collections in `apps/backoffice/src/collections/`, and the Payload config in `apps/backoffice/src/payload.config.ts`.
8
- - Payload generates `apps/backoffice/src/app/(payload)/`, `apps/backoffice/src/payload-types.ts`, and `apps/backoffice/src/migrations/`. After changing a collection, regenerate them with `pnpm generate:types`, `pnpm generate:importmap`, and `pnpm migrate:create <name>`, and commit the results.
9
- - Read backoffice configuration through `requireEnvironment` in `apps/backoffice/src/environment.ts`. Document each variable in `.env.example`.
5
+ ## Commands
10
6
 
11
- <!-- BEGIN:nextjs-agent-rules -->
7
+ | Task | Command |
8
+ | :---------------------------- | :----------------------------------------------------------------------------------------- |
9
+ | Start both apps with reload | `pnpm dev` |
10
+ | One test | `pnpm --filter ./apps/backoffice exec vitest run src/environment.test.ts -t "<test name>"` |
11
+ | Tests in one app | `TURBO_FILTER=--filter=./apps/app pnpm test` |
12
+ | Unit tests | `pnpm test`, or `pnpm test:coverage` |
13
+ | End-to-end tests | `pnpm test:e2e` |
14
+ | Regenerate after a collection | `pnpm generate:types`, `pnpm generate:importmap` |
15
+ | Create a migration | `pnpm migrate:create <name>` |
16
+ | What `pre-push` runs | `pnpm check` |
17
+ | Every check | `pnpm verify` |
18
+ | Render rules after a change | `pnpm rules:sync` |
12
19
 
13
- ## This is NOT the Next.js you know
20
+ ## How it fits together
14
21
 
15
- This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` (resolved from this file's directory; in monorepos the `next` package may not be visible from the repo root) before writing any code. Heed deprecation notices.
22
+ - Root scripts run lint, format, Knip, and the agent checks once for the workspace, and hand `build`, `test`, `typecheck`, and `depcruise` to Turborepo for each app. `TURBO_FILTER` narrows them; the default is every app.
23
+ - The site lives in `apps/app/app/`. The backoffice site lives in `apps/backoffice/src/app/(frontend)/`, its collections in `apps/backoffice/src/collections/`, and its config in `apps/backoffice/src/payload.config.ts`. The root `generate:*` and `migrate*` scripts run in the backoffice.
24
+ - In development, Payload applies collection changes to the database directly. In production, the backoffice applies the migrations in `apps/backoffice/src/migrations/` when it starts.
16
25
 
17
- This block is written and re-added by `next dev` — verify at `node_modules/next/dist/server/lib/generate-agent-files.js`. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.
26
+ ## Mandatory rules
18
27
 
19
- <!-- END:nextjs-agent-rules -->
28
+ 1. **Follow `.agents/rules/`.** `.agents/rules.json` gives each rule's scope; Claude Code and Cursor load them. After changing either, run `pnpm rules:sync`; `pnpm check` fails on stale copies.
29
+ 2. **Change the backoffice schema only through collections, then regenerate and commit.** Payload generates `apps/backoffice/src/app/(payload)/`, `apps/backoffice/src/payload-types.ts`, and `apps/backoffice/src/migrations/`; run `pnpm generate:types`, `pnpm generate:importmap`, and `pnpm migrate:create <name>`. Do not edit those files by hand.
30
+ 3. **Put unit tests next to the code and Playwright end-to-end tests in `apps/app/test/` and `apps/backoffice/test/` as `*.e2e.test.ts`.** Vitest collects `apps/app/app/**/*.test.{ts,tsx}` and `apps/backoffice/src/**/*.test.{ts,tsx}`.
31
+ 4. **Ask the user before adding component tests.** They need a DOM test environment, and Vitest runs in Node.js.
32
+ 5. **Read backoffice configuration through `requireEnvironment` in `apps/backoffice/src/environment.ts`.** Document each variable in `.env.example`.
33
+
34
+ ## Known pitfalls
35
+
36
+ - **Next.js docs live per app**: this Next.js version differs from your training data. Read the guide in `apps/app/node_modules/next/dist/docs/` or `apps/backoffice/node_modules/next/dist/docs/` before writing Next.js code; the workspace root has no `next` package.
37
+ - **Database for `pnpm dev` and end-to-end tests**: the backoffice needs a PostgreSQL database in `DATABASE_URL` and `PAYLOAD_SECRET` in `.env`; the README lists every variable. Run `pnpm --filter ./apps/app exec playwright install chromium` once before the first `pnpm test:e2e`.
38
+ - **Agent shell gate**: `.agents/hooks/agent-shell-gate.sh` blocks a shell command that writes to a protected path such as `.agents`, `.cursor`, `.claude/rules`, or `.husky`. It is a convenience, not a security boundary: CI and code-owner review are the boundary.
39
+
40
+ ## Related documentation
41
+
42
+ - [README.md](README.md): environment variables, scripts, CI caching, container, deploy
43
+ - [CONTRIBUTING.md](CONTRIBUTING.md): prerequisites, Git hooks, pull requests
@@ -94,7 +94,7 @@ On Vercel, deploy an app without its image. The Next.js preset takes precedence
94
94
  - the `APP_URL` variable: the public Next.js `https://` URL;
95
95
  - the `BACKOFFICE_URL` variable: the public backoffice `https://` URL.
96
96
 
97
- Limit `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
97
+ Limit `dev`, `uat`, and `prod` to the `main` branch and add required reviewers. Environment secrets and variables in a private repository need GitHub Pro, Team, or Enterprise; required reviewers in a private repository need GitHub Enterprise.
98
98
 
99
99
  3. Set the repository variable `DEPLOY_ENABLED` to `true`. Each push to `main` that passes CI then deploys to `dev`. The workflow compares the commit with the last GitHub deployment to that environment and runs `railway up` only for services whose packages changed. A promotion through `uat` or `prod` uses the same comparison against the commit last deployed there, so several commits still ship every changed service. The first deploy to an environment ships both services.
100
100
  4. Promote with **Actions → Deploy → Run workflow**, giving the environment and the full commit SHA. The workflow requires a successful CI run on `main` for that commit and a successful deployment to the previous environment, then waits for `/health` on each service it uploaded.