102 lines
3.5 KiB
Markdown
102 lines
3.5 KiB
Markdown
# Glossary API
|
|
|
|
## Stack
|
|
|
|
- [Nest](https://github.com/nestjs/nest)
|
|
- TypeORM
|
|
|
|
## Project setup
|
|
|
|
```bash
|
|
$ npm install
|
|
```
|
|
|
|
## Running local infrastructure
|
|
|
|
To simplify development, all local infrastructure is handled with Docker. The folder `dev_infra` contains the folloeing:
|
|
|
|
- `compose.yaml`: A Docker compose file that stands up a Postgres database and a pgAdmin instance to visualize.
|
|
|
|
### Database Migrations
|
|
|
|
Any time a change is made to a `.entity.ts` file, a new migration will need to be generated and added to the `appDataSource.ts` file. This ensures the API is refencing the most up-to-date (and valid!) database schema. These are the migration commands:
|
|
|
|
```bash
|
|
# generate migration
|
|
$ npm run db:gen_migration
|
|
|
|
# generate migration with a custom name
|
|
$ npm run db:gen_migration_named --name=<any_name_here>
|
|
|
|
# show migrations
|
|
$ npm run db:show_migrations
|
|
|
|
# run migrations
|
|
$ npm run db:run_migrations
|
|
```
|
|
|
|
**NOTE ON MIGRATIONS IN TYPEORM**: In order for any new migration to be considered in the `db:show_migrations` or `db:run_migrations` commands, they'll need to be added to the `appDataSource.ts` file, under the `migrations: []` option.
|
|
|
|
## Compile and run the project
|
|
|
|
```bash
|
|
# Set env variables, which default to local infrastructure
|
|
$ . ./set-env
|
|
|
|
# development
|
|
$ npm run start
|
|
|
|
# watch mode
|
|
$ npm run start:dev
|
|
|
|
# production mode
|
|
$ npm run start:prod
|
|
```
|
|
|
|
## Run tests
|
|
|
|
```bash
|
|
# unit tests
|
|
$ npm run test
|
|
|
|
# e2e tests
|
|
$ npm run test:e2e
|
|
|
|
# test coverage
|
|
$ npm run test:cov
|
|
```
|
|
|
|
## Deployment
|
|
|
|
When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
|
|
|
|
If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
|
|
|
|
```bash
|
|
$ npm install -g @nestjs/mau
|
|
$ mau deploy
|
|
```
|
|
|
|
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
|
|
|
|
## Resources
|
|
|
|
Check out a few resources that may come in handy when working with NestJS:
|
|
|
|
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
|
|
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
|
|
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
|
|
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
|
|
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
|
|
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
|
|
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
|
|
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
|
|
|
|
## 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).
|
|
|
|
## License
|
|
|
|
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
|