Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 0 additions & 140 deletions .dockerignore

This file was deleted.

1 change: 1 addition & 0 deletions .dockerignore
101 changes: 18 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,33 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>
# OmniBox Backend

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
## Dev

<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://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" alt="Donate us"/></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" alt="Follow us on Twitter"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
### Docker

## Description
+ Watch & Debug mode

[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
```shell
docker compose -f compose.yaml -f dev.yaml up
```

## Project setup
+ Build mode

```bash
$ pnpm install
```
```shell
docker compose -f compose.yaml -f build.yaml up --build
```

## Compile and run the project
### locally

```bash
# development
# Setup
$ pnpm install

# Development
$ pnpm run start

# watch mode
# Watch mode
$ pnpm run start:dev

# production mode
# Production mode
$ pnpm run start:prod
```

## Run tests

```bash
# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm 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
$ pnpm 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).

## Stay in touch

- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)

## License

Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
4 changes: 4 additions & 0 deletions build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# docker compose -f compose.yaml -f build.yaml up --build
services:
app:
build: .
18 changes: 0 additions & 18 deletions compose.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
# Do not use this file in production.
name: omnibox-backend-dev

services:
app:
image: node:22
ports:
- "${PORT}:${PORT}"
env_file:
- .env
working_dir: /app
volumes:
- ${PWD}:/app
- ${PWD}/.tmp/node_modules:/app/node_modules
command: ["sh", "-c", "npm install && npm run start:debug"]
depends_on:
db:
condition: service_healthy

db:
image: postgres:17-alpine
ports:
Expand All @@ -33,13 +25,3 @@ services:
interval: 5s
timeout: 3s
retries: 5

pgadmin:
image: dpage/pgadmin4
ports:
- '8888:80'
environment:
PGADMIN_DEFAULT_EMAIL: user-name@domain-name.com
PGADMIN_DEFAULT_PASSWORD: strong-password
volumes:
- ${PWD}/.tmp/pgadmin:/var/lib/pgadmin
19 changes: 19 additions & 0 deletions dev.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# docker compose -f compose.yaml -f dev.yaml up
services:
app:
image: node:22
working_dir: /app
volumes:
- ${PWD}:/app
- ${PWD}/.tmp/node_modules:/app/node_modules
command: ["sh", "-c", "npm install && npm run start:debug"]

pgadmin:
image: dpage/pgadmin4
ports:
- '8888:80'
environment:
PGADMIN_DEFAULT_EMAIL: user-name@domain-name.com
PGADMIN_DEFAULT_PASSWORD: strong-password
volumes:
- ${PWD}/.tmp/pgadmin:/var/lib/pgadmin