Code Monkey home page Code Monkey logo

nodejs-microservice-boilerplate's Introduction

[nodejs-microservice-boilerplate]

Get Started

  1. **Install [Node]
  2. Clone this repository. - git clone https://github.com/hassanajazch/nodejs-microservice-boilerplate.git
  3. Install Node Packages. - npm install
  4. Run the app for development. - npm run dev
  5. Create and build app for production. - npm start

------------- Project Details -------------

Boilerplate for Node.js applications.

  • Sequelize ORM for MySQL queries
  • dotenv for loading env variables
  • ESM and Babel for using ES6 features
  • JEST for testing

Structure

  • Separate app and server
  • Usage of patterns [factories and adapters]
  • Separate route and controller file for different categories
  • keep all business logic in src/app folder
  • Single Responsibility

Code Style

  • Use eslint to maintain code standards
  • Use prettier to keep code format same across all team
  • Use proper naming convention (No use of result, abc named variables)
  • Use all ES6 features

Testing

  • Use JEST for testing
  • Use AAA pattern for writing your tests

Inspiration:

nodejs-microservice-boilerplate's People

Contributors

hassanajazlunchon avatar

Stargazers

 avatar Obada Qawwas avatar akash bhalke avatar Hassan Ajaz 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.