https://github.com/bc-fullstack-03/celio_amaral-backend
Projeto de uma api restfull para o desenvolvimento de uma rede social na SysMap Excellence Full Stack Trainee 3ª edição.
https://github.com/bc-fullstack-03/celio_amaral-backend
aws-s3 backend docker insomnia java mongodb spring-boot swagger
Last synced: 2 months ago
JSON representation
Projeto de uma api restfull para o desenvolvimento de uma rede social na SysMap Excellence Full Stack Trainee 3ª edição.
- Host: GitHub
- URL: https://github.com/bc-fullstack-03/celio_amaral-backend
- Owner: bc-fullstack-03
- Created: 2023-05-09T01:09:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-19T22:57:30.000Z (almost 3 years ago)
- Last Synced: 2025-02-25T19:34:01.773Z (over 1 year ago)
- Topics: aws-s3, backend, docker, insomnia, java, mongodb, spring-boot, swagger
- Language: Java
- Homepage:
- Size: 174 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Parrot Social Network(Connect)
- ### Back-End
Projeto de uma api restfull para o desenvolvimento de uma rede social na SysMap Excellence Full Stack Trainee 3ª edição.
- #### Other technologies:
--> Spring Data
--> MongoRepository
--> Maven
--> Insomnia REST API
--> Swagger
#### Run the API project:
• Requirements: Java 20/Spring Boot 3.0.6/MongoDB 6.0.5/Docker
```bash
# Clone repository
git clone https://github.com/bc-fullstack-03/Celio_Amaral-Backend.git
```
• Then open the terminal in the restApi folder that contains the docker-compose.yml file and type the following command:
docker compose up -d
#### Localstack
• To successfully upload images to localstack, you need to run the following command:
```shell
docker exec -it localstack bash
```
• And inside localstack bash, run the following command:
```shell
aws configure --profile default
```
```shell
AWS Access Key ID [None]: mykey
AWS Secret Access Key [None]: mykey
Default region name [None]: us-west-2
Default output format [None]: json
```
• After that, you need to run the following command to create the bucket:
```shell
aws s3 mb s3://demo-bucket --endpoint-url http://localhost:4566/
```
#### Autenticação
• Now that the celioamaral20/rest-Api, mongo and localstack/localstack image containers are running locally with the docker-compose. yml, it is now possible to use the application.
• To use the application using the Swagger client and access the endpoint documentation, access the following URL in your browser:
🔗 http://localhost:8082/swagger-ui/swagger-ui/index.html 🔗
• To pass information in the request header, such as the token, you can consume the API endpoints via Postman or Insomnia.
```java
// Open the 'Backend/restapi' project in the editor of your choice
// Run the file 'RestApiApplication.java'
RestApiApplication.java
```
#### Comments:
Infelizmente não tive como fazer o build da aplicação no Docker, devido a falta de infraestrutura no momento.. mas agradeço a SysMap Solutions, Renan e Bruno pela oportunidade de aprendizado e conhecimento nas tecnologias apresentadas neste projeto de API. Gostaria de entregar pelo menos um código funcional, onde fiz os testes de forma local.
#### Post/Get User:
- ### [Front-End](https://github.com/bc-fullstack-03/Celio_Amaral-Frontend)
- ### [Mobile](https://github.com/bc-fullstack-03/Celio-Amaral_Mobile)
## Author
- [@CelioAmaral](https://github.com/CelioAmaral)
