This commit is contained in:
64
README.md
64
README.md
@@ -1,54 +1,28 @@
|
||||
# api.us.dev
|
||||
# us.dev Generalized API
|
||||
|
||||
## Description
|
||||
AKA _the monolith_
|
||||
|
||||
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
|
||||
## Quickstart
|
||||
|
||||
## Installation
|
||||
Dependencies:
|
||||
|
||||
```bash
|
||||
$ yarn install
|
||||
- Docker
|
||||
- Node 18
|
||||
|
||||
```sh
|
||||
# Copy example .env
|
||||
cp .env.example .env
|
||||
# Install Dependencies
|
||||
yarn
|
||||
# Start local services
|
||||
docker compose up -d
|
||||
# Copy default data into local minio
|
||||
cp -r default/* data/minio/devbucket
|
||||
# Start Application
|
||||
yarn start:dev
|
||||
```
|
||||
|
||||
## Running the app
|
||||
|
||||
```bash
|
||||
# development
|
||||
$ yarn run start
|
||||
|
||||
# watch mode
|
||||
$ yarn run start:dev
|
||||
|
||||
# production mode
|
||||
$ yarn run start:prod
|
||||
```
|
||||
|
||||
## Test
|
||||
|
||||
```bash
|
||||
# unit tests
|
||||
$ yarn run test
|
||||
|
||||
# e2e tests
|
||||
$ yarn run test:e2e
|
||||
|
||||
# test coverage
|
||||
$ yarn 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).
|
||||
Visit http://localhost:3000/api
|
||||
|
||||
## Configuration
|
||||
|
||||
|
Reference in New Issue
Block a user