This is the backend server for an address book application using Node.js and Express.js
To get the Node server running locally:
- Clone this repo
npm installto install all required dependencies- Install MongoDB Community Edition (instructions) and run it by executing
mongod - Fill in the config.js under config-fake folder with your Firebase info (you will have to make your on database if you do not already have one(https://docs.mongodb.com/manual/installation/#tutorials))and JWT_SECRET with your own secret
- In config.js and config.json make sure to fill in MONGO_URI to equal your mongo db URI which looks something like 'mongodb://localhost:27017/{nameofdatabase}'
- You can then start the server using
node server.js
##NPM TEST -You can run 'npm test' in the terminal in the root of the project to make sure that the routes are working
##POSTMAN -You can either create requests using Postman('https://www.getpostman.com/') at 'localhost:4000/' or 'https://floating-gorge-67548.herokuapp.com/' with the routes below. Test the routes in order.
To test routes below make sure to grab x-auth token in the header response and then for your header request fill in key value with x-auth under key and the token under value.
##Routes
This route is to create/register our user.
Request body:
{
"firstName": string,
"lastName": string,
"email": string,
"password": string
}
Response body:
{
"firstName": "Joshi",
"lastName": "Vallejo",
"email": "vallejodudemon@gmail.com",
"_id": "5af7ac67a31ab1c2036fbb41"
}
This route is used to login our user
Request body:
{
"email": string,
"password": string
}
Response body:
{
"firstName": "Joshi",
"lastName": "Vallejo",
"email": "vallejodudemon@gmail.com",
"_id": "5af7ac67a31ab1c2036fbb41"
}
This route is to get the information of who is logged in using a token
Header
{
"x-auth": "token
}
Response body:
{
}
This route is user to create a contact, route is protected so one would need to be logged in and have a token to add to user
Header
{
"x-auth": "token
}
Request body:
{
"contactFirstName"": string,
"contactLastName"": string,
"email": string,
"phone": string
}
Response body:
{
"contactFirstName"": "Joshi",
"contactLastName"": "VallejoMon",
"email": "vallejodudemon@gmail.com",
"phone": "8087223333"
}
This route is to logout also using a token to logout
Header
{
"x-auth": "token
}
Response body:
{
Logged Out
}
- bcryptjs - Used for hashing passwords
- body-parser - Parse incoming request bodies in a middleware before your handlers, available under the req.body property
- express-rate-limit - Basic rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.
- expressjs - The server for handling and routing HTTP requests
- express-validator - User for validating data before sending it to server
- firebase - User to initialize firebase, in this case Firebase database
- helmet - Helmet helps you secure your Express apps by setting various HTTP headers
- jsonwebtoken - For generating JWTs used by authentication
- lodash - Gives access to the Lodash library
- jsonwebtoken - For generating JWTs used by authentication
- mongodb - Gives us access to Mongodb
- mongoose - For modeling and mapping MongoDB data to javascript
- router - Simple middleware-style router
- snyk - Snyk helps you find, fix and monitor known vulnerabilities in Node.js npm
- validator - A library of string validators and sanitizers.
- chai - Chai is an assertion library, similar to Node's built-in assert. It makes testing much easier by giving you lots of assertions you can run against your code.
- chai-http - HTTP integration testing with Chai assertions.
- mocha - ☕️ Simple, flexible, fun JavaScript test framework for Node.js & The Browser ☕️
- supertest - Super-agent driven library for testing node.js HTTP servers using a fluent API
server.js- The entry point to our application. This file defines our express server and connects it to MongoDB using mongoose. It also requires the routes and models we'll be using in the application.config-fake/- file to give a model of what the config should look likedb/- This contains our initlization code of Mongoose and Firebasemiddleware/- This contains our custom middleware, in this case our authenicate middleware used to create private routesmodels/- This folder contains the schema definitions for our Mongoose models.routes/- This folder contains the route definitions for our API.routes/test- This folder contains our test for both our contact and user routesroutes/test/seed- This contains our dummy data for our test database