search

fiap-pos / tech-challenge

1 stars 0 forks source link

readme

Sistema de Controle de Pedidos para Lanchonete

Este projeto é um sistema de controle de pedidos para uma lanchonete. Ele possui as seguintes funcionalidades:

Rotas disponíveis na API

Todas as rotas estão listadas através do Swagger no endereço http://localhost:8080/swagger-ui/index.html

Obs.: Sugerimos o Insomnia e já disponibilizamos uma collection em collections/insomnia

Pré-requisitos

Antes de executar o projeto, verifique se você possui os seguintes requisitos:

Imagem Docker do projeto

Podemos encontrar a imagem do projeto no seguinte repositório do Docker hub vwnunes/tech-challenge-61

Executando o Projeto

Siga as instruções abaixo para executar o projeto via docker/docker-compose:

  1. Faça o clone deste repositório: https://github.com/fiap-pos/tech-challenge.git
  2. Acesse o diretório do projeto: cd tech-challenge
  3. Execute o comando para iniciar o ambiente Docker: docker-compose up -d
  4. Aguarde até que os containers estejam prontos e em execução.
  5. Acesse a API pelo seu client de escolha pelo seguinte endereço base: http://localhost:8080

Caso queira buildar o projeto fora do container, siga os passos abaixo:

  1. Certifique-se de ter o Java 17 instalado em sua máquina.
  2. Acesse o diretório do projeto: 
        cd tech-challenge
  3. Execute o comando para buildar o projeto: 
        ./mvnw clean package
  4. Execute o comando para iniciar o ambiente Docker: 
        docker-compose -f docker-compose-local.yml up -d
  5. Execute o comando para executar a aplicação: 
        ./mvnw spring-boot:run -Dspring-boot.run.profiles=local
  6. Acesse a API pelo seu client de escolha pelo seguinte endereço base: http://localhost:8080

Caso queira rodar o projeto dentro de um cluster kubernetes local

  1. Certifiquece de ter o kubectl instalado e devidamente configurado para cluster kubernetes
  2. Execute o comando: 
        kubectl apply -f deployment
  3. Aguarde até que os pods estejam com status de RUNNING. Os pods da applicação podem apresentar erros até que o mysql termine de subir
  4. Acessando o serviço:
    • Acesse a API pelo seu client de escolha pelo seguinte endereço base: http://{IP_DO_SEU_CLUSTER}:30000
    • Se você estiver utilizando o minikube obetenha a url da aplição através do comando: 
      minikube service lanchonete-service --url

Contribuidores