freeCodeCamp/api
2024-10-22 11:15:19 +02:00
..
__mocks__ feat(api): add exam-environment endpoints (#55662) 2024-10-04 09:20:18 -05:00
prisma feat(api): add exam-environment endpoints (#55662) 2024-10-04 09:20:18 -05:00
src fix(api): specify openapi version (#56781) 2024-10-22 11:15:19 +02:00
tools fix(api): use port 27017 (#54220) 2024-04-02 17:07:02 -07:00
.gitignore feat: create docker images for new api (#51538) 2023-09-13 02:15:25 +05:30
jest.config.ts test: speed up api tests (#53969) 2024-03-09 10:36:19 +05:30
jest.utils.test.ts test: minor fix to how cookies are passed around (#55259) 2024-06-21 08:36:46 -07:00
jest.utils.ts refactor: move CSRF code into plugin (#56447) 2024-10-04 12:56:04 +00:00
package.json feat(api): add exam-environment endpoints (#55662) 2024-10-04 09:20:18 -05:00
README.md feat(api): add exam-environment endpoints (#55662) 2024-10-04 09:20:18 -05:00
tsconfig.build.json feat: create docker images for new api (#51538) 2023-09-13 02:15:25 +05:30
tsconfig.json refactor(api): import ts-reset in entrypoint (#51677) 2023-09-28 09:40:51 -07:00

Working on the new api

Connecting to local database

The api uses the ORM Prisma and it needs the MongoDB instance to be a replica set.

Atlas

If you use MongoDB Atlas, the set is managed for you.

Local

The simplest way to run a replica set locally is to use the docker-compose file in /tools.

cd tools
docker compose up -d

The new db will be empty, so you can run the seed script to populate it.

cd ../.. # back to the root of the repo
pnpm seed

Login in development/testing

During development and testing, the api exposes the endpoint GET auth/dev-callback. Calling this will log you in as the user with the email foo@bar.com by setting the session cookie for that user.

Generating Exams

pnpm run generate-exams <ENV_EXAM_ID> <NUMBER_OF_EXAMS_TO_GENERATE>