https://github.com/mayllu/mayllu-backend
Backend API for handle user posts, media uploads, reactions, and AI-based analysis to optimize the city's urban management. Built with NestJS and PostgreSQL using TypeORM.
https://github.com/mayllu/mayllu-backend
api-rest backend mayllu nestjs postgresql typeorm
Last synced: 3 months ago
JSON representation
Backend API for handle user posts, media uploads, reactions, and AI-based analysis to optimize the city's urban management. Built with NestJS and PostgreSQL using TypeORM.
- Host: GitHub
- URL: https://github.com/mayllu/mayllu-backend
- Owner: Mayllu
- Created: 2024-09-21T14:36:02.000Z (almost 2 years ago)
- Default Branch: feature/mongodb-integration
- Last Pushed: 2024-11-19T20:37:56.000Z (over 1 year ago)
- Last Synced: 2025-03-19T02:11:25.467Z (over 1 year ago)
- Topics: api-rest, backend, mayllu, nestjs, postgresql, typeorm
- Language: TypeScript
- Homepage: https://bit.ly/mayllu-docs
- Size: 206 KB
- Stars: 2
- Watchers: 0
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 NestJS Backend For Mayllu
Bienvenido al proyecto de backend para Mayllu creado con **NestJS**. Este proyecto proporciona una base sĂłlida y escalable para construir aplicaciones web modernas y eficientes.
## 🛠️ TecnologĂas Usadas
- [NestJS](https://nestjs.com/) - Framework para construir aplicaciones del lado del servidor
- [TypeScript](https://www.typescriptlang.org/) - Un superconjunto de JavaScript que añade tipos estáticos
- [PostgreSQL](https://www.postgresql.org/) - Sistema de gestiĂłn de bases de datos relacional
- [TypeORM](https://typeorm.io/) - ORM para TypeScript y JavaScript
## 🚀 Archivo env
Ejemplo de archivo env para poder desarrollar el software frontend, reemplazar con sus propias api key
```
MAYLLU_MONGO_URI=
MAYLLU_BACKEND_PORT=
JWT_SECRET=
B2_APPLICATION_KEY_ID=
B2_APPLICATION_KEY=
B2_BUCKET_ID=
B2_BUCKET_NAME=
GOOGLE_API_KEY=
```
## 📦 Instalación
Sigue estos pasos para configurar el proyecto en tu máquina local:
1. **Clona el repositorio:**
```bash
git clone https://github.com/tu-usuario/nestjs-backend.git
```
2. **Navega al directorio del proyecto:**
```bash
cd nestjs-backend
```
3. **Instala las dependencias:**
```bash
npm install
```
4. **Configura el archivo `.env`:**
Copia el archivo `.env.example` a `.env` y ajusta las variables segĂşn tu configuraciĂłn.
5. **Inicia el servidor:**
```bash
npm run start:dev
```
## ⚙️ Estructura del Proyecto
```
nestjs-backend/
│
├── src/
│ ├── app.module.ts # MĂłdulo raĂz de la aplicaciĂłn
│ ├── main.ts # Archivo de entrada
│ ├── modules/ # Módulos de la aplicación
│ ├── controllers/ # Controladores
│ └── services/ # Servicios
│
├── .env # Variables de entorno
├── package.json # Dependencias y scripts
└── README.md # Documentación del proyecto
```
## 🌟 CaracterĂsticas
- **RESTful API**: Crea y consume servicios RESTful fácilmente.
- **ValidaciĂłn**: Uso de `class-validator` para validar los datos de entrada.
- **AutenticaciĂłn**: ImplementaciĂłn de JWT para proteger rutas y recursos.
- **InteracciĂłn con Base de Datos**: ConexiĂłn a PostgreSQL usando TypeORM.
- **Manejo de Errores**: Captura y manejo centralizado de errores.
## đź”— Enlaces Ăštiles
- [DocumentaciĂłn de NestJS](https://docs.nestjs.com/)
- [Ejemplo de API REST](https://docs.nestjs.com/techniques/http)
- [GuĂa de TypeORM](https://typeorm.io/#/)
## 🛠️ Contribución
Las contribuciones son bienvenidas. Si deseas contribuir a este proyecto, por favor sigue estos pasos:
1. Haz un fork del proyecto
2. Crea una nueva rama (`git checkout -b feature/nueva-caracteristica`)
3. Realiza tus cambios y haz commit (`git commit -m 'Añadir nueva caracterĂstica'`)
4. EnvĂa tu rama (`git push origin feature/nueva-caracteristica`)
5. Abre un Pull Request
## đź“„ Licencia
Este proyecto está licenciado bajo la [MIT License](LICENSE).
---
¡Gracias por tu interés en este proyecto! Si tienes preguntas o sugerencias, no dudes en abrir un issue.