Skip to content

soat-fiap/FIAP.TechChallenge.ByteMeBurger

Repository files navigation

FIAP Tech Challenge - ByteMeBurger API

CI

Description

This repository contains the source code for the ByteMeBurger API, part of the FIAP Tech Challenge. The API is designed to manage a burger restaurant's operations, including order placement, customer registration, and product management. The recent updates introduce a new endpoint for customer registration and enhance various aspects of the application, such as error handling, data models, and service configurations.

Tech challenge deliverables

You can find all Phase 1 deliverables on the Wiki page

Getting Started

Prerequisites

  • Docker
  • .NET SDK
  • Optionally, an IDE such as Visual Studio or VSCode

Setup

  1. Clone the repository:

    git clone https://github.com/soat-fiap/FIAP.TechChallenge.ByteMeBurger.git
    cd FIAP.TechChallenge.ByteMeBurger
  2. Configure environment variables

    • Configure .env file. You can use the .env.sample
    • Remember to create the .env file
  3. Start the services using Docker:

     docker-compose up -d
  4. Service health (check if the service is healthy before testing)

    http://localhost:8080/healthz

  5. To verify the existing endpoints, go to

    http://localhost:8080/swagger/index.html

  6. If you want to quickly seed the database with fake data and test some of the endpoints use the FIAP_TechChallenge_ByteMeBurger-endpoints.http file

  7. Logs should (not guaranteed) be available in here http://localhost:8081

  8. Stop the services using Docker:

     docker-compose down