Giter Site home page Giter Site logo

node-bloodboiler-sequelized's Introduction

Node API Bloodboiler ๐Ÿš€

Build Codacy Badge codecov GitHub Release MIT License sequelized version

A API boilerplate built on top of ExpressJS.

Features

  • Database: NoSQL with MongoDB/Mongoose;
  • Authentication: Authenticate users with JWT;
  • Logs: Logging info with Winston/Morgan;
  • Tests: Unit/Integration Tests running with Jest;
  • Error handling: Centralized error handling middleware;
  • Security:
    • CORS enabled;
    • Secured HTTP headers using Helmet;
    • Protecting requests against xss;
    • Data validation middleware using Yup
  • Code Analisys: Codecov/Codacy;
  • Linting: ESLint/Prettier;
  • API Documentation: Swagger/Postman;

Getting Started

Installation Steps

Clone the repository

$ git clone https://github.com/lucas-a-pelegrino/node-bloodboiler
$ cd node-bloodboiler

Install the dependencies

$ npm install
# or
$ yarn install

Setup environment variables (modify/add more variables if needed)

$ cp .env.example .env

Commands

Start application

# locally:
$ npm run start:dev
$ yarn start:dev

# staging:
$ npm run start:staging
$ yarn start:staging

# production
$ npm start
$ yarn start

Testing

# Run tests
$ npm test
$ yarn test

Documentation

You might want to check the API docs as well!

  • Collection on Postman;
  • Swagger: Just start the application at your desired host:port and use the route: /api/v1/documentation to open the swagger docs;

License

MIT

node-bloodboiler-sequelized's People

Contributors

lucas-a-pelegrino avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.