https://github.com/joaquindecima/backend-desapp-api

Proyecto de Desarrollo de Aplicaciones UNQ S2 2022
https://github.com/joaquindecima/backend-desapp-api

mongodb mongoose nodejs rest-api swagger unq

Last synced: 3 months ago
JSON representation

Proyecto de Desarrollo de Aplicaciones UNQ S2 2022

• Host: GitHub
• URL: https://github.com/joaquindecima/backend-desapp-api
• Owner: JoaquinDecima
• License: gpl-3.0
• Created: 2022-08-24T23:34:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T13:51:23.000Z (over 3 years ago)
• Last Synced: 2023-05-15T10:01:07.428Z (about 3 years ago)
• Topics: mongodb, mongoose, nodejs, rest-api, swagger, unq
• Language: JavaScript
• Homepage: https://backend-desapp.herokuapp.com/
• Size: 161 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# DesApp Backend

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=JoaquinDecima_backend-desapp-api&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=JoaquinDecima_backend-desapp-api)

[![GitHub issues](https://img.shields.io/github/issues/JoaquinDecima/backend-desapp-api?style=for-the-badge)](https://github.com/JoaquinDecima/backend-desapp-api/issues)

[![GitHub license](https://img.shields.io/github/license/JoaquinDecima/backend-desapp-api?style=for-the-badge)](https://github.com/JoaquinDecima/backend-desapp-api)

Proyecto para la materia Desarrollo de Aplicaciones de la UNQ.

## Descripción

Este proyecto es una API REST que permite la gestión de usuarios, y transacciones.

* Backend: 

    * NodeJS

    * Express _express_

    * JWT _jesonwebtoken_

    * Bcrypt _bcrypt_

    * Swagger _swagger-jsdoc_ _swagger-ui-express_

    * Mocha _mocha_ _chai_

    * MongoDB _mongoose_

    * Cache _apicache_ _redis_

    * Axios _axios_

    * Dotenv _dotenv_

    * Schedule _node-schedule_ (para Binance)

    * API Logger ~~_morgan_~~ _on-finished_ _pino_ (audit)

* Servicios: 

    * Restful

    * Swagger

* Infra: 

    * Github

    * Github Actions

    * ~~Heroku~~ __caido__

## Instalación

### Requisitos

* NodeJS

* MongoDB

### Instalación

1. Clonar el repositorio

```bash

git clone git@github.com:JoaquinDecima/backend-desapp-api.git

```

2. Instalar dependencias

```bash

npm install

```

3. Crear archivo .env

```bash

cp .env.example .env

```

4. Correr el proyecto

```bash

npm run dev

```

## Documentación

La documentación de la API se encuentra en la ruta `/docs`

## Tests

Para correr los tests unitarios y de integración

```bash

npm run test

```

Para correr los tests de Arquitectura

```bash

npm run test:arch

```

## Autor

* **Joaquín (Pato) Decima** - *Desarrollador* - [JoaquinDecima]

[JoaquinDecima]: https://joaquindecima.ml/