rest-api-node

rest-api-node copied to clipboard

Node API

Description

Node API is production ready and open source project in Node, Express and MongoDB

Documentation

Swagger Docs https://rest-api-node-413916.uc.r.appspot.com/docs/

Support

This application is hosted on Google Cloud Platfom and serve a bunch of AJAX requests to give and manipulate data from database and give a support to test front end applications

Servers

Showcase

Routes

Projects

Users

Collections

Schema Project (projects)

Schema User (users)

API

API Directories

• Public Routes ./src/routes/public
• Private Routes ./src/routes/private
• Models ./src/app/Models
• Controllers ./src/app/Controllers
• Services ./src/app/Services
• Config consign and express ./src/config/express.js
• Server configuration and application startup ./server.js

Configuring the API locally

• Download or clone the project access the project folder with the terminal and execute the CLI npm install
• Create your .env file with the following configuration
  • WORKERS: How many workers you need
  • AUTO_SCALE: When enabled will create workers by CPU Eg.: CPU * WORKERS
  • DATABASE_URL: Your database URL
  • AUTH_ROUNDS and AUTH_SECRET: Those are used for authentication and verification

WORKERS=1
AUTO_SCALE=true
DATABASE_URL=mongodb+srv://<user>:<password>@cluster0.mongodb.net/?retryWrites=true&w=majority
AUTH_ROUNDS=15
AUTH_SECRET=docssecret

• Run the server npm start
• Access in your browser http://localhost:8080/projects
• For deployment is important to update app.yaml to your service_account and can be found on your GCP

API Dependencies

• Dependency express - https://www.npmjs.com/package/express
• Dependency body-parser - https://www.npmjs.com/package/body-parser
• Dependency cors - https://www.npmjs.com/package/cors
• Dependency consign - https://www.npmjs.com/package/consign
• Dependency mongoose - https://www.npmjs.com/package/mongoose

By: Renan Lopes