https://github.com/nelsonwenner/challenge-trz-node-api
The resident zombie - Backend :rage3:
https://github.com/nelsonwenner/challenge-trz-node-api
docker docker-compose jest nodejs postgres test typeorm typescript
Last synced: 2 months ago
JSON representation
The resident zombie - Backend :rage3:
- Host: GitHub
- URL: https://github.com/nelsonwenner/challenge-trz-node-api
- Owner: nelsonwenner
- License: mit
- Created: 2020-11-18T23:08:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-07T21:05:31.000Z (almost 5 years ago)
- Last Synced: 2025-01-14T11:22:07.542Z (9 months ago)
- Topics: docker, docker-compose, jest, nodejs, postgres, test, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 734 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
TRZ (The resident zombie) - API
## :telescope: Diagram Database
## :rocket: Technologies
* [Typescript](https://www.typescriptlang.org/)
* [NodeJS](https://nodejs.org/en/)
* [Postgres](www.postgresql.org)
* [TypeOrm](https://typeorm.io/)
* [Docker](https://www.docker.com/)
## :electric_plug: Prerequisites
- [NodeJS LTS (>= 12.x)](https://nodejs.org/)
- [Docker (>= 19.03.x)](https://docs.docker.com/engine/install/ubuntu/)
- [Docker Compose (>= 1.05.x)](https://docs.docker.com/compose/install/)
## :information_source: Getting Started
1. Fork this repository and clone it on your machine.
2. Change the directory to `trz-api` where you cloned it.
## :closed_lock_with_key: Backend Getting Started
```shell
/* Run docker */
$ docker-compose up -d
/* Down docker */
$ docker-compose down
```
* Open backend, the host [localhost:3333](http://localhost:3333)
## :toolbox: Running the tests
```shell
/* Access container of backend */
$ docker exec -it api-container /bin/bash
/* Run test */
$ npm run test:coverage
```
## :spiral_notepad: Swagger
With the server running, access [http://localhost:3333/docs](http://localhost:3333/docs)
## :memo: License
This project is under the MIT license. See the [LICENSE](LICENSE.md) for more information.
---