https://github.com/bc-fullstack-03/thais-cavalcante-backend

https://github.com/bc-fullstack-03/thais-cavalcante-backend

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bc-fullstack-03/thais-cavalcante-backend
• Owner: bc-fullstack-03
• Created: 2023-04-28T12:22:10.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-10T03:00:23.000Z (about 3 years ago)
• Last Synced: 2025-01-08T08:40:43.774Z (over 1 year ago)
• Language: Java
• Size: 142 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


 
PARROT API





- [🧾 Descrição](#-descrição)

- [🔧 Tech stack](#-tech-stack)

- [🚀 Rodando o projeto](#-rodando-o-projeto)

  - [Pré-Requisitos](#pre-requisitos)

  - [Clonando o repositório](#clonando-repositorio)

  - [Rodando](#running)

  - [Documentação Swagger](#swagger)

  - [Autenticação](#autenticação)

- [👤 Desenvolvedora](#-desenvolvedora)






## 🧾 Descrição

**Projeto Backend - Programa Trainee SysMap de Excelência Full Stack**

**Objetivo:** Desenvolver uma API para uma rede social.






## 🔧 Tech stack

- Java 17

- Spring Boot 3.0.6

- Spring Data MongoDB

- Docker






## 🚀 Rodando o projeto



### Pré-Requisitos

Antes de começar, certifique-se de que o Docker esteja instalado em sua máquina.






### Clonando o repositório

```

## SSH

git@github.com:bc-fullstack-03/thais-cavalcante-backend.git

```

```

## HTTPS

https://github.com/bc-fullstack-03/thais-cavalcante-backend.git

```

```

## GitHub CLI

gh repo clone bc-fullstack-03/thais-cavalcante-backend

```



### Rodando

```

docker compose up

```






### Configurando o LocalStack

```

aws configure --profile default

```

```

AWS Access Key ID [None]: mykey

AWS Secret Access Key [None]: mykey

Default region name [None]: us-west-2

Default output format [None]: json

```

```

aws s3 mb s3://demo-bucket –endpoint-url http://localhost:4566

```






### Documentação Swagger

Acesse a seguinte URL em seu navegador:

**http://localhost:8082/swagger-ui/index.html**

Isso abrirá a interface do Swagger, onde você pode testar os endpoints da API.




![screenshot (11)](https://github.com/bc-fullstack-03/thais-cavalcante-backend/assets/94868398/2286c84e-a775-45d2-9d00-aa97a64c7d0a)






### Autenticação

Com exceção da rota de criar usuário e da própria rota de autenticação, todas as outras rotas só podem ser acessadas por um usuário autenticado. Então tenha certeza de que está logado antes de testar os outros endpoints. 

![screenshot (12)](https://github.com/bc-fullstack-03/thais-cavalcante-backend/assets/94868398/64bf5539-277b-4d41-921e-fec52f121a87)



## 👤 Desenvolvedora

[Thais Cavalcante](https://www.linkedin.com/in/thaispcavalcante/)