Skip to content

invercity/express-starter-kit

Repository files navigation

Node.JS Express Starter KIT

GitHub package.json version Tests Depfu Codacy Badge LIcense

Starter KIT for Express based apps

Features

  • Express REST service
  • Bootstrap 3.x based UI****
  • SMTP mailer
  • ESLint checking
  • Github actions
  • Logging with log4js
  • Mocha + Supertest tests
  • Basic Docker

TODO

  • Swagger
  • Replace bower with npm
  • Vue@3, bootstrap@5 setup

Requirements

  • Node.JS v16 and above

Installation

Clone project, and install app dependencies:

npm i

Configure app

Edit config/<ENV>.json using your favourite editor to configure app

Check js style

npm run lint

Run tests

npm test

Running application

npm start

Running application in Docker

npm run docker_up

By default, application will work on localhost:3000