https://github.com/savecoders/urlshortnest
Url Short Test - Nestjs Postgresql
https://github.com/savecoders/urlshortnest
nestjs postgresql typeorm typescript
Last synced: 9 months ago
JSON representation
Url Short Test - Nestjs Postgresql
- Host: GitHub
- URL: https://github.com/savecoders/urlshortnest
- Owner: Savecoders
- Created: 2024-03-25T21:32:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-29T22:10:45.000Z (10 months ago)
- Last Synced: 2025-05-29T23:20:54.334Z (10 months ago)
- Topics: nestjs, postgresql, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 310 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
# Url-Short | Api 📎
Url-Short that contains both the frontend and backend code for our application. The frontend is built using ReactJS and the backend is built using NestJS.
## Repository Structure
In this repository is organized as follows:
- `/src`: This directory contains the NestJS backend application.
- `/docs`: This directory contains all the project documentation, including requirements, data flow diagrams, state diagrams, and BPMN2 diagrams.
## Description
This an api from Url-short with nestjs and Auth JWT.
## Installation
```bash
pnpm install
```
## Up Docker
```bash
docker-compose --env-file .env up -d
```
> [!NOTE]
> Docker-compose read default envirioment file `.env` you have rename `.env.template` and change the value form variables
## Up seed in Development
```bash
http://localhost:3000/api/seed
```
## Running the app
```bash
# development
pnpm run start
# watch mode
pnpm run start:dev
# production mode
pnpm run start:prod
```
## Test
```bash
# unit tests
$ pnpm run test
# e2e tests
$ pnpm run test:e2e
# test coverage
$ pnpm run test:cov
```
## License
Nest is [MIT licensed](LICENSE).