kevquincke / node-api-base

API boilerplate project for NodeJS with Typescript

Node API Base

Node Api Base is a boilerplate project for JSON RESTful APIs. It's based on Node v10.3.0 and Typescript v3.0.3.

Features

This template comes with:

• Schema
  • Users table with roles (Admin and Regular by default)
• Endpoints
  • Sign up regular user
  • Sign up admin user with authentication and authorization
  • Authentication for both kinds of users
• Middleware
  • Authentication
  • Authorization (based on roles)
  • Exception handling
• Tests
  • Unit tests for user
  • Integration tests for API
• Code quality tools
• API documentation following https://apiblueprint.org/

How to use

1. Clone this repo
2. Rename the folder and change name in package.json to the project name
3. Create an .env file
4. In the .env file set the following values:

   JWT_KEY = secret -> a secret value for json web token hashing
   DATABASE_URL = database url with format postgres://user:secret@host:port/database_name
   

   If you want to use another database instead of using postgres you'll need to change the app.ts database connection method and also set the database url to an accordingly format
5. Run yarn
6. Run yarn run dev to run on development
7. You can now try your REST services!

Note: when creating an entity it must be exported in models/index.ts in order to be used. Tests: To run the tests after step 5, run yarn run test (make sure to point to a test database on DATABASE_URL)

Deploying to Heroku

1. Run heroku create appName on the repo
2. Add Heroku Postgres add-on (or whatever database you're using)
3. Set environment values in heroku settings, as shown in the previous section (DATABASE_URL is probably already set)
4. Run git push heroku branch (whatever branch you want to push)

NPM Packages

1. body-parser Node.js body parsing middleware
2. class-validator Validate incoming data
3. dotenv Loads environment variables from a .env file to process.env
4. express Fast, unopinionated, minimalist web framework for NodeJS
5. lodash The Lodash library exported as Node.js modules
6. pg Non-blocking PostgreSQL client for NodeJS
7. pug High performance template engine
8. reflect-metadata Runtime reflection on types
9. typeorm ORM that can run in NodeJS
10. ts-node TypeScript execution and REPL for NodeJS
11. tslint Extensible static analysis tool for TypeScript
12. typescript Language for application-scale JavaScript
13. bcrypt Lib to help to hash passwords
14. express-async-errors Simple ES6 async/await support hack for ExpressJS
15. winston A logger for just about everything
16. jsonwebtoken An implementation of JSON Web Tokens
17. jest Delightful JavaScript Testing
18. ts-jest TypeScript preprocessor with source map support for Jest
19. supertest HTTP assertions made easy via superagent
20. tslint-eslint-rules TypeScript rules available in ESLint

Api Docs

https://nodeapibase.docs.apiary.io

Current version

v1.0.0

node-api-base's Issues

Use Passport.js to authenticate users

Passport.js (http://www.passportjs.org/) is a great library to handle authentication instead of doing it by hand using JWT.

It would be great to use Passport to authenticate users, and it'll add the possibility to add Facebook, Gmail, etc as strategies in the future.