API powering Tracker Client applications.
If you want to work on this project, you need to run through a few setup steps. Although I will only highlight them here, you can message Ben Bryant for more information.
- Fork and clone the project from Github
- Install the project dependencies using npm or yarn
- Create a
.envfile in your root directory, and copy the contents from.env.templateinto that file - Next, you will replace the environment variable values with real values. Part of this will include you having a MongoDB Atlas account. Then you will be able to:
- create a new database for this project
- locate your MongoDB connection string
- locate your MongoDB user and password
- For
BASE_URLandPORT, just make sure they match. In development, they can behttp://localhost:8080and8080respectively. - For
AUTH_SECRET,ACCESS_TOKEN_SECRET, andREFRESH_TOKEN_SECRET, this can be any string, but make sure it is at least 32 bytes long for security purposes. - (Optional) Lastly, have Postman downloaded, and import the project collection located at
data/Express-Testing-All.postman_collection.json
At this point you should be up and running for development! All contributions are welcome.
npm startruns the Express applicationnpm run devruns the development servernpm run buildcompiles the project using Babelnpm run testruns the Jest test runner