Ntask API

Overview

Node.js API for task management. This is an educational project about how to create an API using Node.js with SQL database and JSON Web Token authentication.

Modules

• Express - Web Framework.
• Sequelize - ORM compatible with SQL databases.
• Passport - Middleware for user authentication.
• Mocha - Test Runner for Node.js.
• Chai - BDD and TDD interface for test implementation.
• ApiDoc - Inline Documentation for RESTful web APIs.

And there's more in the project package.json.

Installation

• Clone the repository: git clone git@github.com:oifelipesan/ntask-api.git
• Access the project directory: cd ntask-api
• Install the dependencies: yarn install or npm install
• Start the server: yarn start or npm start
• Run tests: yarn test

Documentation

Router for API Documentation: /doc

Note: Documentation written in Brazilian Portuguese.

About

Building REST APIs with Node.js - Visit the Code House website.

Thank you @Caio Ribeiro Pereira. Building APIs with Node.js was an awesome read and it was succint.