https://github.com/bc-fullstack-03/caroline-ferraz--backend

https://github.com/bc-fullstack-03/caroline-ferraz--backend

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/bc-fullstack-03/caroline-ferraz--backend
• Owner: bc-fullstack-03
• Created: 2023-04-28T13:08:38.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-09T18:22:58.000Z (about 3 years ago)
• Last Synced: 2025-01-08T08:40:44.470Z (over 1 year ago)
• Language: Java
• Size: 133 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
🐦 Parrot (backend) 🐦


📝 Descrição:

Repositório destinado ao versionamento e compartilhamento dos códigos referentes ao backend da aplicação Parrot, feita durante o bootcamp de desenvolvimento full stack promovido pela Sysmap Solutions.


🎯 Objetivos:

O objetivo central do projeto foi desenvolver uma solução funcional para o backend de um Blog, que atendesse a um modelo figma pré-estabelecido e que aplicasse o máximo possível dos princípios/conceitos de desenvolvimento de software abordados durante as aulas. Dentre os requisitos mínimos, foram solicitados a implementação de autenticação de usuário com token JWT, o upload de fotos utilizando o LocalStack, a documentação da API utilizando o Swagger e que ao final fosse utilizado um arquivo docker-compose.yml para orquestrar os serviços utilizados e subir a imagem da aplicação para o Docker Hub.


🛠 Tecnologias utilizadas:



 - 

 - 

 - 

 - 

 - 

 - 

 - 

 - 





👨‍💻 Utilizando a Aplicação:

• Tendo o Docker instalado, crie um arquivo docker-compose.yml em uma pasta vazia e cole no arquivo o seguinte conteúdo:




version: "3"

services:

    mongodb:

        image: mongo:latest

        container_name: "mongo_parrot"

        ports:

            - "27070:27017"

    localstack:

        image: localstack/localstack

        container_name: localstack_parrot

        ports:

            - "4566:4566"

            - "4510-4559:4510-4559"

            - "8055:8080"

        environment:

            - SERVICES=s3

            - DEBUG=1

            - DATA_DIR=/tmp/localstack/data

        volumes:

            - ./tmp/localstack:/tmp/localstack

            - /var/run/docker.sock:/var/run/docker.sock

    parrot_backend:

        image: carolineferraz/parrot_backend:latest

        build: .

        container_name: parrot_backend

        ports:

            - "8082:8082"



• Em seguida abra o terminal na pasta que contém o arquivo e digite o seguinte comando:

docker compose up -d

• Agora que os contêineres das imagens carolineferraz/parrot_backend, mongo e localstack/localstack estão rodando localmente com as configurações do arquivo docker-compose.yml, já é possível utilizar a aplicação.

• Para utilizar a aplicação utilizando o client do Swagger e acessar a documentação dos endpoints, acesse a seguinte URL no navegador:

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

• Para passar informações no header da requisição, como o token, você pode consumir os endpoints da API via Postman:







![video-postman](https://github.com/bc-fullstack-03/Caroline-Ferraz--backend/assets/95757534/33ac3305-5749-4688-b2a2-b7b38656e620)



😄 Muito obrigada e até uma próxima!

☕ Desenvolvido por Caroline Ferraz