# AGENTS.md

FCC China open source codebase and curriculum. Learn to code and help nonprofits.

## Setup

```
npm install
```

## Commands

```
npm run start                 # run the app
npm run build                 # produce a build
npm run test                  # run the test suite, must pass before any commit
npm run lint                  # lint
npm run only-once
npm run create-rev
npm run prestart-production
npm run start-production
```

## Layout

- `common/` 71 source files
- `server/` 53 source files
- `client/` 28 source files
- `public/` 20 source files
- `seed/`   8 source files
- `test/`   2 source files

## Conventions

- Tests live alongside the code they cover, following `test/server/utils/date-utils-test.js`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `public/js/angular.js` is 1122KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.