gabrielhws / node-express-sample-api

The initial design instructions of an API that uses node.js and express.

README

Use this README to assist in the initial design instructions of an API that uses node.js and express.

Get an API for you to use in your Startup project. This is a conceptual project and may be outdated. If you have doubts, send me an email. Cheers. =D

"Comece uma API para você usar no seu projeto para sua Startup ou estudos. Este é um projeto conceitual e pode estar desatualizado. Se tiver dúvidas, me manda um e-mail. Abraços."

What is this repository for?

• Gabriel Ferreira - Node.js/Express.js Sample Rest API
• Version: 1.0.0
• Repository

Technology

• Node.js
• Express.js
• ECMAScript 6
• Babel
• Mongoose
• MANDRILL
• SENDGRID
• MOIP - Brazilian Payment Platform
• Stripe SDK
• PayPal SDK
• Deployment instructions

Guideline

• Install MongoDB (https://www.mongodb.com/)
• Install Node.JS (https://nodejs.org/en/)
• Install Mongochef (https://studio3t.com/download/)
• Create an account at MLAB (https://mlab.com/)
• Create an account at Mandrill (https://www.mandrill.com/)
• Create an MOIP account using your CNPJ - MEI or SIMPLES or others (https://moip.com.br/)

Instructions

• Download: git clone https://github.com/gabrielhws/node-express-sample-api.git
• Install: npm install
• Set the MONGO DB database keys in: ./src/config/env/development, ./src/config/env/local, ./src/config/env/production
• Run developmet: npm start
• Run local: NODE_ENV=local npm start
• Run PROD: NODE_ENV=production npm start
• Open: http://localhost:3001/

Contact

• Website
• [e-mail]