jkguidaven / node-express-project-template

A project template based on Node.js/Express.js that follows recommended practices

node-express-project-template

This repository contains a project template for building an enterprise-grade Node.js project written in typescript programming language. The project is based on Express web framework. The template was designed to follow and incorporate the best practices in developing Node applications. Practices such as scalable project structure, dependency injection, 3-layer architecture, unit and integration testing, automated code linting, continuous integration and many more.

The project also includes integration on localization (i18n), job scheduler, mail service, RDBMS Query builder/ORM , Pub/sub systems, graphQL, mongoDB, and oAuth2 providers. please refer to the plugins section to learn more.

Basic usage

• Installing the dependencies.

npm install

• Running the app in dev environment.

npm start

• Building the production app.

npm run build

• Running testing and linting.

# Running both unit and integration test
npm test

# Or you can run the test script individually
npm run test:unit
npm run test:integration

## running lint
npm run lint