Quickstart

Prerequisites

Clone and install

git clone <your-repo-url>
cd d79-directory-app
npm install

Create environment file

cp .env.example .env.local

Fill in values from Environment variables. Never commit .env.local.

Configure Google OAuth

Seed an authorized user

Google sign-in rejects any @schools.nyc.gov address that is not already in the users collection.

npm run seed-users

Update src/scripts/seed-users.js to match the accounts you actually need before running it in production.

Start the app

npm run dev

Open http://localhost:3000, then Sign in.

Caption: Add screenshot showing the Google sign-in card and the @schools.nyc.gov restriction notice.

Verify the stack

curl -s http://localhost:3000/api/public/overview | jq

Expect currentYear (July–June school year), requiredPlans, and schoolsServed. Super Admins can also open /admin/system after sign-in.

npm run build
npm start

The production build uses webpack (next build --webpack). Page files may only export a default page (plus reserved fields such as metadata).

After Mongoose schema changes, restart npm run dev. Next.js can keep a stale model in memory.

Command	Purpose
`npm run dev`	Next.js dev server
`npm run build`	Production webpack build
`npm start`	Serve the production build
`npm run seed-users`	Insert authorized users
`npm run assign-principals`	Attach principals to existing forms
`npm run fix-form`	Repair form permission assignments
`node src/scripts/create-demo-users.js`	Upsert demo Principal/AP for role preview (cannot Google-sign-in)