Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 828 Bytes

README.md

File metadata and controls

49 lines (37 loc) · 828 Bytes

Getting started

Important! this requires Node >= 14, Express >= 4 and TypeScript >= 4.

.env file must be created for this application to work. rename .envExample to .env and fill out the SMTP info.

# install dependencies
    npm install

# serve
    npm run start

# build for production
    npm run build
    npm run start:prod

Docker

# build docker image
docker compose build

# start docker image
docker compose up

Barrelsby

This project uses barrelsby to generate index files to import the controllers.

Edit .barrelsby.json to customize it:

{
  "directory": [
    "./src/controllers/rest",
    "./src/controllers/pages"
  ],
  "exclude": [
    "__mock__",
    "__mocks__",
    ".spec.ts"
  ],
  "delete": true
}