> An awesome project based on Ts.ED framework
## Getting started
> **Important!** Ts.ED requires Node >= 20.x or Bun.js and TypeScript >= 5.
```batch
# install dependencies
$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm{{/if}}{{#if pnpm}}pnpm{{/if}} install
# serve
$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm run{{/if}}{{#if pnpm}}pnpm{{/if}} start
# build for production
$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm run{{/if}}{{#if pnpm}}pnpm{{/if}} build
$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm run{{/if}}{{#if pnpm}}pnpm{{/if}} start:prod
```
## Docker
```
# build docker image
docker compose build
# start docker image
docker compose up
```
## Barrels
This project uses [barrels](https://www.npmjs.com/package/@tsed/barrels) to generate index files to import the controllers.
Edit `.barrels.json` to customize it:
```json
{
"directory": [
"./src/controllers/rest",
"./src/controllers/pages"
],
"exclude": [
"**/__mock__",
"**/__mocks__",
"**/*.spec.ts"
],
"delete": true
}
```