https://github.com/jonasdamher/poesiaeventual_api

API rest para obtener información sobre editoriales, poesía, libros y sus autores.
https://github.com/jonasdamher/poesiaeventual_api

api authors books editorials express mongodb nodejs poems rest typescript

Last synced: 4 days ago
JSON representation

API rest para obtener información sobre editoriales, poesía, libros y sus autores.

• Host: GitHub
• URL: https://github.com/jonasdamher/poesiaeventual_api
• Owner: jonasdamher
• Created: 2021-04-01T00:11:36.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T14:57:05.000Z (10 months ago)
• Last Synced: 2024-04-05T15:55:11.509Z (10 months ago)
• Topics: api, authors, books, editorials, express, mongodb, nodejs, poems, rest, typescript
• Language: TypeScript
• Homepage:
• Size: 827 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PoesiaEventual_API

API para obtener información sobre editoriales, poesía, libros y sus autores.

 

[![Maintainability](https://api.codeclimate.com/v1/badges/b9e666c3b0d77aeff54e/maintainability)](https://codeclimate.com/github/jonasdamher/PoesiaEventual_API/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/b9e666c3b0d77aeff54e/test_coverage)](https://codeclimate.com/github/jonasdamher/PoesiaEventual_API/test_coverage)

### Docker

[Docker](https://hub.docker.com/r/jonasdamher/poesiaeventual_api)

### :books: Instalar las librerías necesarias.

```npm install```

### :page_with_curl: Archivo .env.

Renombrar archivo ```.dev-env``` a ```.env``` y añadir credenciales necesarias.

### :gear: Transpilar proyecto de typescript a javascript.

```npm run build```

### :heavy_check_mark: Iniciar proyecto.

```npm run start```

### Iniciar proyecto en modo desarrollo.

```npm run dev```

### Ejecutar test

```npm run test```

### Crear imagen de docker

```npm run docker```

### Ejecutar lint en el proyecto

```npm run lint```

### Ejecutar lint en el proyecto y tratar de solucionar posibles errores

```npm run lint:fix```

### Documentation - spanish

[Documentación v2](https://documenter.getpostman.com/view/8382203/TzmCgYL3)