This project is based on the DevCamper API created by Brad Traversy.
The goal of this project is to provide a functioning API that serves as the backend for an application that displays developer bootcamp information. My goal in providing this project, based on a well-known example, is to incorporate a testing challenge into it. There is currently no active frontend for this application, so the focus is entirely on building and testing an API.
In order to run the development version, you must have a Mongo database setup, either locally or in the cloud. You then need to provide a mongodb.env
file in the config
directory. This file should contain the following environment variable:
MONGO_URI = mongodb+srv://<username>:<password>@devcamper-wisqb.mongodb.net/devcamper?retryWrites=true&w=majority
Here you have to replace <username>
and <password>
with your own credentials. Note that this file is part is ignored by Git and thus is not checked in as part of the versioning process.
It is also necessary to provide a geocoder.env
file in the config
directory that has the following:
GEOCODER_API_KEY=<your consumer key>
Here you have to enter your consumer key from the MapQuest developer setup.
For development purposes, you can start the server with:
npm run dev
If you want to run tests, do the following from the project root:
npm test
Resource route structure of the application:
- /api/v1/bootcamps
- /api/v1/courses
- /api/v1/reviews
- /api/v1/auth
- /api/v1/users