CodeCow/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-06-13 21:02:08 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
63c19acfc3
freeCodeCamp/api
History
Oliver Eyton-Williams 8cd2efe570
feat: base64 encode file contents when making api requests (#62006) 
Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>
2025-09-02 16:20:48 +02:00
..
__mocks__ feat(api): s/jest/vitest/g (#61863) 2025-08-25 22:57:56 +05:30
prisma chore(api): rename ExamEnvironmentTempExam -> ExamCreatorExam (#61868) 2025-08-19 12:46:02 +02:00
src feat: base64 encode file contents when making api requests (#62006) 2025-09-02 16:20:48 +02:00
tools feat(api): add exam env attempts endpoints and fields (#59634) 2025-07-16 11:35:12 -05:00
.gitignore feat: create docker images for new api (#51538) 2023-09-13 02:15:25 +05:30
package.json feat(api): s/jest/vitest/g (#61863) 2025-08-25 22:57:56 +05:30
README.md chore(api): add exam-env test script (#60445) 2025-05-27 09:53:51 +05:30
tsconfig.build.json refactor(api): organise tooling (#59931) 2025-04-24 10:27:23 +05:30
tsconfig.json feat(api): s/jest/vitest/g (#61863) 2025-08-25 22:57:56 +05:30
vitest.utils.test.ts feat(api): s/jest/vitest/g (#61863) 2025-08-25 22:57:56 +05:30
vitest.utils.ts feat(api): s/jest/vitest/g (#61863) 2025-08-25 22:57:56 +05:30

README.md

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

Troubleshooting

If you have any issues connecting to the database (e.g. MongoServerError: not primary), try removing the volume and recreating the containers.

cd tools
docker compose down -v
docker compose up -d

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 exam-env:generate <ENV_EXAM_ID> <NUMBER_OF_EXAMS_TO_GENERATE>