https://github.com/mauricioromagnollo/heroes-api
🦸 A simple API built with Node.js to study infrastructure with Docker, Kubernetes, Terraform, AWS and other technologies.
https://github.com/mauricioromagnollo/heroes-api
aws-eks docker kubernetes nodejs postgresql sequelize terraform
Last synced: about 2 months ago
JSON representation
🦸 A simple API built with Node.js to study infrastructure with Docker, Kubernetes, Terraform, AWS and other technologies.
- Host: GitHub
- URL: https://github.com/mauricioromagnollo/heroes-api
- Owner: mauricioromagnollo
- License: mit
- Created: 2022-04-11T00:43:40.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T01:34:37.000Z (over 3 years ago)
- Last Synced: 2025-06-01T04:12:55.720Z (about 1 year ago)
- Topics: aws-eks, docker, kubernetes, nodejs, postgresql, sequelize, terraform
- Language: JavaScript
- Homepage:
- Size: 6.77 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Heroes API
### Requirements
* Node.js v8+ or Docker and Docker Compose
* Postgres running on local instance or Docker
### Running on localMachine
* Install dependencies - `npm i`
* Run project - `npm start`
### OR: Docker
* `docker-compose up`
### OR: Alternatives on pulling from Docker hub
* Docker hub image: [mauricioromagnollo/heroes-api](https://hub.docker.com/r/mauricioromagnollo/heroes-api/)
```shell
docker run -d -p 5432:5432 --name postgres \
--env POSTGRES_PASSWORD=mysecretpassword \
--env POSTGRES_DB=heroes\
postgres
```
```shell
docker run -p 3000:3000 \
--link postgres:postgres \
-e POSTGRES_HOST=postgres:mysecretpassword@postgres:5432 \
-e POSTGRES_DB=heroes \
-e POSTGRES_SSL=false \
erickwendel/nodejs-with-postgres-api-example:latest
```
### Viewing
* Go to swagger page - `localhost:3000/documentation`