Ts.ED - biz-control-pro

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
$ yarn install

# serve
$ yarn start

# build for production
$ yarn build
$ yarn start:prod

Docker

# create and start services
docker-compose -f docker-compose.services.yml up -d

# build docker Ts.ED image
docker compose build

# create and start Ts.ED container
docker compose up -d

# stop Ts.ED container
docker compose down

# remove Ts.ED image
docker compose down --rmi all

Swagger

A swagger documentation is available on the /api-docs endpoint.

swagger/docs

Insomnia

Import the file Insomnia.json into Insomnia to test the API.

Insomnia

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
}