greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: improve new api's mongodb setup guide (#50392) 

* docs: improve new api's mongodb setup guide

* docs: give example variable

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>

* Update api/README.md

---------

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>
Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>
pull/50405/head
Oliver Eyton-Williams 2023-05-16 18:04:41 +02:00 committed by GitHub
parent 092cd9bd95
commit f6df0f3aed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
api/README.md
View File

@ -11,14 +11,27 @@ 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. First disable any running MongoDB instance on your machine, then run
the docker-compose file.
in /tools.
```bash
cd tools
docker compose up -d
```
Once that's running, update the connection string in the `.env` file to use port `27018`.
```txt
# Database
MONGOHQ_URL=mongodb://127.0.0.1:27018/freecodecamp?directConnection=true
```
The new db will be empty, so you can run the seed script to populate it.
```bash
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.