https://github.com/nikolam-dev/parq-api-nest
🐘 NestJS + Postgres SQL + Swagger + Geolocation
https://github.com/nikolam-dev/parq-api-nest
geolocation nestjs postgresql rest-api swagger
Last synced: 2 months ago
JSON representation
🐘 NestJS + Postgres SQL + Swagger + Geolocation
- Host: GitHub
- URL: https://github.com/nikolam-dev/parq-api-nest
- Owner: NikolaM-Dev
- Created: 2021-10-27T13:46:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-28T23:10:21.000Z (over 4 years ago)
- Last Synced: 2025-12-26T10:49:25.442Z (6 months ago)
- Topics: geolocation, nestjs, postgresql, rest-api, swagger
- Language: TypeScript
- Homepage: https://parq-nest-api.herokuapp.com/api/docs/
- Size: 568 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🐘 PARQ Api Nest y Postgres
Rest Api NestJS + Postgres SQL para usuarios y obtener sus coordenadas con la API de geolocalización de Google. Con auto documentación con Swagger.
## Contenido
Este proyecto tiene una rama: principal, contiene el producto final.
Llevando a cabo la estrategia de flujo de trabajo de git [desarrollo basado en troncos](https://trunkbaseddevelopment.com/)
## Instalación
### Cómo iniciar el contenedor y correr la API 🐘
```sh
# Levantar en desarrollo
docker-compose up dev
# Levantar para ambientes productivos
docker-compose up prod
```
> No olvide completar las variables de `.env.example` en `.env`
### Migraciones
```sh
# dev o prod según sea el caso
docker-compose exec dev bash
# Estando conectamos corremos las migraciones necesarias
```
> Mirar el `package.json` para ver todos los comando scripts de migraciones
## Data Flow
## Requerimientos
- [ ] Pruebas Unitarias.
- [x] Crear DockerFile para ejecución del código en container.
- [x] Documentación API.
- [x] Usar TypeScript.
- [x] End-points solicitados
## Documentación
La documentación se encuentra en el `/api/docs`, estando allí conocerá todos los endpoints y como usarlos