intended-server/README.md

1.3 KiB

Ts.ED logo

Ts.ED - intended-server


Website   •   Getting started   •   Slack   •   Twitter

An awesome project based on Ts.ED framework

Getting started

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

# 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 .barreslby.json to customize it:

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