FootAPI

The goal of this project is to provide an API for managing football-related data regarding future matches and where to watch them. The application follows good development practices (clean code organization, proper layering, configuration isolation, testing, containerized deployment, etc).

---

Technologies

• Python
• FastAPI
• PostgreSQL
• Docker / Docker Compose
• Nginx
• SQLAlchemy
• Alembic

---

Requirements

To run this project, you only need:

• Docker
• Docker Compose

There is no need to install Python locally.

---

How to run the project

1) Clone the repository

git clone git@github.com:AugustoMagalhaes/footapi.git
cd footapi

Setup the .env file

POSTGRES_USER=footapi
POSTGRES_PASSWORD=footapi
POSTGRES_DB=footapi

DATABASE_URL=postgresql+asyncpg://footapi:footapi@db:5432/footapi

Start the application

docker-compose up --build

or, if you don't want to leave the terminal hanging:

docker-compose up --build -d

Acessing the application

If everything went well on docker process the API will be available at:

http://localhost:8000

Interactive documentation:

http://localhost:8000/docs

Health check endpoint:

http://localhost:8000/health

If you find any bugs, have suggestions, or want to propose improvements, please open an issue at: https://github.com/AugustoMagalhaes/footapi/issues

You can also contact me via linkedin link on my profile ☺️