[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:

• Yoni Goldberg https://github.com/i0natan/nodebestpractices
• Sahat https://github.com/sahat/hackathon-starter