68 lines
1.4 KiB
Markdown
68 lines
1.4 KiB
Markdown
|
<p style="text-align: center" align="center">
|
||
|
|
<a href="https://tsed.dev" target="_blank"><img src="https://tsed.dev/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<div align="center">
|
||
|
|
<h1>Ts.ED - backend</h1>
|
||
|
|
<br />
|
||
|
|
<div align="center">
|
||
|
|
<a href="https://cli.tsed.dev/">Website</a>
|
||
|
|
<span> • </span>
|
||
|
|
<a href="https://cli.tsed.dev/getting-started.html">Getting started</a>
|
||
|
|
<span> • </span>
|
||
|
|
<a href="https://slack.tsed.dev">Slack</a>
|
||
|
|
<span> • </span>
|
||
|
|
<a href="https://twitter.com/TsED_io">Twitter</a>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
</div>
|
||
|
|
|
||
|
|
> 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
|
||
|
|
$ 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
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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
|
||
|
|
}
|
||
|
|
```
|