Switched to NestJS
This commit is contained in:
@@ -1,67 +1,73 @@
|
||||
<p style="text-align: center" align="center">
|
||||
<a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
|
||||
<p align="center">
|
||||
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
<h1>Ts.ED - backend</h1>
|
||||
<br />
|
||||
<div align="center">
|
||||
<a href="https://cli.tsed.io/">Website</a>
|
||||
<span> • </span>
|
||||
<a href="https://cli.tsed.io/getting-started.html">Getting started</a>
|
||||
<span> • </span>
|
||||
<a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
|
||||
<span> • </span>
|
||||
<a href="https://twitter.com/TsED_io">Twitter</a>
|
||||
</div>
|
||||
<hr />
|
||||
</div>
|
||||
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
|
||||
[circleci-url]: https://circleci.com/gh/nestjs/nest
|
||||
|
||||
> An awesome project based on Ts.ED framework
|
||||
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
|
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
|
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
|
||||
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
|
||||
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
|
||||
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
|
||||
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
|
||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
|
||||
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
|
||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
|
||||
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
|
||||
</p>
|
||||
<!--[](https://opencollective.com/nest#backer)
|
||||
[](https://opencollective.com/nest#sponsor)-->
|
||||
|
||||
## Getting started
|
||||
## Description
|
||||
|
||||
> **Important!** Ts.ED requires Node >= 14, Express >= 4 and TypeScript >= 4.
|
||||
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
|
||||
|
||||
```batch
|
||||
# install dependencies
|
||||
$ install
|
||||
## Installation
|
||||
|
||||
# serve
|
||||
$ start
|
||||
|
||||
# build for production
|
||||
$ build
|
||||
$ start:prod
|
||||
```bash
|
||||
$ npm install
|
||||
```
|
||||
|
||||
## Docker
|
||||
## Running the app
|
||||
|
||||
```
|
||||
# build docker image
|
||||
docker compose build
|
||||
```bash
|
||||
# development
|
||||
$ npm run start
|
||||
|
||||
# start docker image
|
||||
docker compose up
|
||||
# watch mode
|
||||
$ npm run start:dev
|
||||
|
||||
# production mode
|
||||
$ npm run start:prod
|
||||
```
|
||||
|
||||
## Barrelsby
|
||||
## Test
|
||||
|
||||
This project uses [barrelsby](https://www.npmjs.com/package/barrelsby) to generate index files to import the controllers.
|
||||
```bash
|
||||
# unit tests
|
||||
$ npm run test
|
||||
|
||||
Edit `.barreslby.json` to customize it:
|
||||
# e2e tests
|
||||
$ npm run test:e2e
|
||||
|
||||
```json
|
||||
{
|
||||
"directory": [
|
||||
"./src/controllers/rest",
|
||||
"./src/controllers/pages"
|
||||
],
|
||||
"exclude": [
|
||||
"__mock__",
|
||||
"__mocks__",
|
||||
".spec.ts"
|
||||
],
|
||||
"delete": true
|
||||
}
|
||||
# test coverage
|
||||
$ npm run test:cov
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
|
||||
|
||||
## Stay in touch
|
||||
|
||||
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
|
||||
- Website - [https://nestjs.com](https://nestjs.com/)
|
||||
- Twitter - [@nestframework](https://twitter.com/nestframework)
|
||||
|
||||
## License
|
||||
|
||||
Nest is [MIT licensed](LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user