node-express-ts-eslint

node-express-ts-eslint is a project that provides you with a boilerplate tool to create a node.js API with an ES6 transpiler while following the ts-standard eslint rules.

Features

• Simple /api/ endpoint that provides you a JSON object {hi: 'there'}.
• Simple /api/_health endpoint to check the status of the API.
• Simple /api/demo endpoint that makes use of a router and controllers to return a JSON object {hello: 'world'}.
• All code following Airbnb's Javascript (ES6) style guide.

• Pre-commit script to prevent commit files that could break your app in production.
• /docs endpoint with the API documentation for external users

Components

• ESlint
• Node.js
• Express.js
• Swagger

Getting start

Just run the following commands in your terminal to start coding

$ git clone https://github.com/imjpfeliciano/node-express-ts-eslint
$ cd node-express-ts-eslint
$ nvm use
$ npm install

You'll need to create an .env file following the values specified in .env.sample. You can copy existing one using:

cp .env.sample .env

Then run:

$ npm run start:dev

The last command automatically runs the API exposed on http://localhost:5001.

Deployment

TBD

Contributing

This project is an initiative to make the way you create an API easier. Feel free to propose new things and changes that help us with this task. You can read our CONTRIBUTE.md for more information.