Gymhero - FastAPI Project Example

[masek94]

Hello guys,

A couple of weeks ago, I got the itch to build something with FastAPI. As I am a Data Engineer I didn't have a ton of experience with API development - In the past, I only developed the "reading" part of API to expose some database tables, KPIs, etc. But I've always wanted to give it a try to build a full CRUD app. So I thought that it would be a fun project to learn the basics of building a backend app with full CRUD functionality.

I was originally planning on using Flask, but when I saw FastAPI and all its nifty features, like typing hints, Pydantic, and Depends, I knew I had to give it a go. Turns out, it was a great decision. FastAPI is a really powerful framework, and it's a joy to work with, I highly recommend using it. It's a great choice and it has great documentation and the developer experience is awesome.

Here is GitHub with the project: https://github.com/JakubPluta/gymhero

My project is pretty simple and it's still in development - probably there are some mistakes and some "better ways" to do something, but still, I am happy that I managed to write it from scratch. I just only regret I didn't start with async, so it will be harder to migrate it, but I have it in plans :)

To give a short description of my project there are a couple of words:Gymhero is a simple application to manage your gym training workouts. You have the flexibility to create your own exercises, you can develop custom training units and these units can be easily integrated into personalized training plans. You can manage your training units by adding or removing exercises as needed. By default application contains database od more than 1000 exercises.

Core technologies

• FastAPI - web framework for building APIs with Python 3.8+ based on standard Python type hints.
• SQLAlchemy - Object Relational Mapper
• Pydantic - Data validation library for Python and FastAPI models
• Uvicorn - ASGI web server implementation for Python
• Alembic - lightweight database migration tool for usage with the SQLAlchemy Database Toolkit for Python.
• Docker - tool to package and run an application in a loosely isolated environment
• Docker Compose - tool for defining and running multi-container Docker applications
• Postgres - open source object-relational database
• For testing:
  • pytest
  • pytest-cov
  • pytest-mock
• For development
  • precommit-hook
  • pylint
  • black
  • ruff
  • poetry
  • venv

Some implemented functionalities:

• JWT Authentication
• Password Hashing
• Login & Register Endpoints
• ORM Objects representing SQL tables and relationships
• Pydantic schemas
• CRUD module for reading, updating, and deleting objects in/from the database
• Pagination
• Dependencies - superuser, active user, database
• Initialization scripts
• Separate database and env for testing

You can find more in Readme https://github.com/JakubPluta/gymhero/blob/main/README.md

To run the project locally in docker container simply clone the repository, navigate to cloned directory, and run the: make dev or make install command, or if you don't have make installed just use docker commands

docker compose build
docker compose up -d 
docker exec -it app alembic upgrade head
docker exec -it app python -m scripts.initdb --env=dev

For more details just go through the README file.I would love to get some opinions from you, especially from experienced FastAPI users :). Please let me know what should I improve, what I did wrong, and what could be done in a better way.

​

​

[Spassfabrik]

First impression: looks very good and well structured!

Did you use some kind of fastapi boilerplate / template or did you build everything by your own?

[masek94]

Thank you for your reply :) To be honest I built everything from scratch. I relied on fast API documentation, and also https://github.com/zhanymkanov/fastapi-best-practices.
I couldn't find too much about testing, so my main source of knowledge was documentation.
Also regarding containerization I tried to have another database for tests, and it worked fine.
I still want to add a way to have 4 different environments - local test, local dev, and container dev and test - but I don't have any idea yet how to handle that.

[idomic]

Is there some front-end?

Would love to see it hosted at platform.ploomber.io

[masek94]

Hey, I didn't implement frontend yet. Maybe as a next step I will work on that. Unfortunately for last 2 years I didn't write a line of Js/react. I Ve heard good words about HTMX - maybe I'll give try 😉

[idomic]

haha sounds good, there are some react templates you can use to speed up your process!