Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fatec-degree/fatec-tg-api-donations-points
API que armazena endereços de pontos de doação de agasalhos. Esses pontos são coletados a partir de um processo de Web Scraping feito pela aplicação Donations Points Scraping.
https://github.com/fatec-degree/fatec-tg-api-donations-points
aws beanstalk cicd docker docker-compose github-actions java jpa maven mysql rds-database s3-bucket sprintboot terraform
Last synced: 1 day ago
JSON representation
API que armazena endereços de pontos de doação de agasalhos. Esses pontos são coletados a partir de um processo de Web Scraping feito pela aplicação Donations Points Scraping.
- Host: GitHub
- URL: https://github.com/fatec-degree/fatec-tg-api-donations-points
- Owner: fatec-degree
- Created: 2022-12-15T01:22:18.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-26T23:36:03.000Z (over 1 year ago)
- Last Synced: 2024-11-13T21:30:15.328Z (2 months ago)
- Topics: aws, beanstalk, cicd, docker, docker-compose, github-actions, java, jpa, maven, mysql, rds-database, s3-bucket, sprintboot, terraform
- Language: HCL
- Homepage:
- Size: 180 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Donations Points
API que armazena endereços de pontos de coleta de agasalhos para doação. Esses pontos são coletados a partir de um processo de **Web Scraping** feito pela aplicação [Donations Points Scraping](https://github.com/PedroHPAlmeida/fatec-tg-scraping-donations-points).
O objetivo destas duas aplicações em conjunto é fazer um "compilado" de pontos de coleta de agasalhos, independente de instituições. Deixando as informações centralizadas em um único lugar e permitindo a fácil consulta.
______
## Tecnologias utilizadas
* Java e Spring para desenvolvimento da API;
* Bancos de dados H2 (em memória) e MySQL;
* Docker para conteinerizar a aplicação e o banco de dados facilitando o desenvolvimento local;
* Docker Compose para subir os múltiplos conteiners da aplicação (conteiner da aplicação e do banco);
* Terraform para provisionar a infraestrutura na cloud AWS;
* Cloud AWS para realizar o deploy da aplicação. Recursos utilizados: AWS Elastic Beanstalk, Amazon S3 e Amazon Relational Database Service (RDS);
* GitHub Actions para CI e CD:
- Automação de testes e build da aplicação;
- Atualização automática da imagem docker da aplicação no repositório do [DockerHub Repository - Pedro](https://hub.docker.com/repository/docker/pedro6571/fatec-tg-api-donations-points);
- Entrega do software em ambiente produtivo de forma automática.
______
## Pré-requisitos para executar o projeto
* Docker version 20.10.22
* Docker Compose v2.6.0
______
## Como executar o projeto
1. Clone este repositório:
```
git clone https://github.com/PedroHPAlmeida/fatec-tg-api-donations-points.git
```
2. Entre na pasta onde se encontram os arquivos ```docker-compose```:
```
cd deploy/docker
```
3. Nesta pasta há dois arquivos: ```docker-compose-dev.yml``` e ```docker-compose-prd.yml```. O objetivo do arquivo ```-dev``` é simular o ambiente de desenvolvimento, contendo um banco de dados H2 (em memória). De forma semelhante o arquivo ```-prd``` simula o ambiente de produção, contendo um banco de dados MySQL. Para executar a aplicação, execute os seguintes comandos:
Para simular o ambiente de dev:
```
docker compose -f docker-compose-dev.yml up -d
```
Para simular o ambiente de prd:
```
docker compose -f docker-compose-prd.yml up -d
```
A aplicação estará em execução na porta 8080:
4. Para buscar dados da API utilize o seguinte endpoint:
```bash
curl --location --request GET 'localhost:8080/api/donations-points'
```
5. Para salvar dados utilize o seguinte endpoint:
```bash
curl --location --request POST 'localhost:8080/api/donations-points' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "string",
"cep": "string",
"state": "string",
"city": "string",
"district": "string",
"street": "string",
"number": "string",
"lng": 0,
"lat": 0
}'
```
6. O Swagger da aplicação se encontra no endereço: http://localhost:8080/swagger-ui/index.html
______