khriztianmoreno / nodejs-scaffolding

A node.js sample application that demonstrates an architecture for building a complete production API with Node.JS, Express.JS and MongoDB

Node.JS - Scaffolding API

Hello, and welcome! This Node.JS sample application that demonstrates an architecture for building a complete production API with Node.JS, Express.JS and MongoDB It features an architectural demonstration of these features:

• Built with Node.js and Express
• REST API with authentication scheme

Express Router and Routes

Route	HTTP Verb	Route Middleware	Description
/api/users	GET		Get list of users
/api/users	POST		Creates a new user
/api/users/:id	GET	isAuthenticated	Get a single user
/api/users/:id	DELETE	hasRole('admin')	Deletes a user, restriction: 'admin'
/api/users/me	GET	isAuthenticated	Get my info
/api/users:id/password	PUT	isAuthenticated	Change a users password

Usage

Basic example Create USER /api/users:

Request Body:

{
  "name": "CRISTIAN MORENO",
  "email": "[email protected]",
  "password": "my-secret-password"
}

Response:

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1OWFiNzkyMWQ1Yzk3NjJlZGQzZmUwZDgiLCJpYXQiOjE1MDQ0MDk4ODksImV4cCI6MTUwNDQyNzg4OX0.2gZPXZ-dQc3kQ1fcIDryHm4gIqWLvcw6guAOnP0ueGU"
}

Getting Started

Prerequisites

• Git
• Node.js and npm Node >= 4.x.x, npm >= 2.x.x
• MongoDB - Keep a running daemon with mongod

Developing

1. Run npm install to install server dependencies.

2. Run mongod in a separate shell to keep an instance of the MongoDB Daemon running

3. Run npm run dev to start the development server. It should automatically open the client in your browser when ready.

4. Open browser http://localhost:3030/api/helloworld.

Contributors

Thanks goes to these wonderful people (emoji key):

Khriztian Moreno 💻 📖 💡

This project follows the all-contributors specification. Contributions of any kind welcome!

nodejs-scaffolding's Issues

expressJwt needs specified algorithm

Hey,

I had to modify auth.service.js to get this to run, adding algorithms: ['RS256'] to the expressJwt configuration.

There are also quite verbose warnings popping up at npm run dev complaining about mongodb settings (but that is probably because I updated it before running since npm informed me that the original mongo version included had severe security problems.

The useMongoClient option is no longer necessary in mongoose 5.x, please remove it.

I think this project seems quite helpful to someone learning about node backend stuff (like me) so I figured I'd comment about it.