Special thanks to the wonderful people that have created all the following technologies. If any packages are included but not mentioned, then they will be in the package.json. ❤️
- Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine.
- Nodemon: A utility that will monitor for any changes in your source and automatically restart your server.
- Express: Fast, unopinionated, minimalist web framework for Node.js
- Our server entry point
- MongoDB: Allows your teams to easily organize, use and enrich data in real time, anywhere.
- Mongoose: Elegant mongodb object modeling for node.js
- Axios: Promise based HTTP client for the browser and node.js
- Jsonwebtoken: JsonWebToken implementation for Node.js
- Passport.js: Simple, unobtrusive authentication for Node.js
Developed in Visual Studio Code.
- Linted with EsLint
- Code styled with Prettier
[Insert list of features here]
[Insert list of future features here]
This project was started without any build tools. It is a straight-up express server.
In the project directory, you can run:
Runs the server with a Node.js runtime environment.
Launches Nodemon to watch for server changes in development mode.
Nodemon is a development dependency and not used for production purposes.
"Run" = execute command in your terminal / command line
- Clone this repository to your local machine
- Run
npm installin your project directory to get all necessary node modules to run the project. - Request the
.envfile from one of the owners to get the necessary configurations. - Place the
.envfile in the root of the project folder. - Run
npm startto begin the fun!
If you do plan on making changes to the project, make sure you create a new branch and make a pull request first.
We have protected our code branches and require a pull request review before merging code.
Special thanks to Talent Path for supporting us to make this project and giving us the resources to succeed in our careers.
MIT © - Aura
June 14, 2019