This project is built on Express and Mongoose.
To run this project you will need Node.js and Yarn v1 installed.
-
Install node - https://nodejs.org/en/
-
Install Yarn v1 - https://classic.yarnpkg.com/en/docs/install/
Node is our runtime for the server, yarn is our package manager and used to run scripts.
In the project directory, you can run:
Runs the server locally in development mode. You can test out the API by connecting to the server using a REST client such as Insomnia or Postman.
You need to have a local instance of MongoDB running.
See the MongoDB Community Edition Install page for a walkthrough, and reach out in the Slack channel if you get stuck.
You also need to have a .env file in your root directory.
To do this, create a file named .env with the following line in it:
DB_CONNECTION = mongodb://localhost/btf
The server will reload if you make edits.
Builds the app for production to the dist folder.
This transpiles the src code using Babel, which allows us to use ES6+ syntax such as import/export.
Your app is ready to be deployed!
Our API resource generator script, replace <resource-name> with the actual name of your resource (e.g. post). This will take care of creating the correct files for you.
Any questions please start on discussion with the lead team.