🏋️‍♂️ MyFiubaGymBro

MyFiubaGymBro is a web platform developed as a project for FIUBA. It is designed to help students stay in shape and keep a healthy track of their habits. The system features a FastAPI backend, a React + TypeScript frontend, and a PostgreSQL database, all orchestrated with Docker and ready for development using DevContainers.

📍 Table of Contents

• 📝 Description
  • 📦 Core Technologies
  • 🧱 Project Structure
• 🚀 Getting Started
  • 📋 Prerequisites
  • ⚙️ Installation
• 💡 Usage
  • 🧪 Local Development (DevContainer)
  • 🛠️ Manual Backend Setup
  • 💻 Manual Frontend Setup
  • 🐳 Docker Compose
• 🤝 Contributing
• 👥 Team
• 📄 License

📝 Description

A detailed platform for student wellness. It uses a layered architecture (routers, dtos, services, repositories) to ensure scalability and maintainability.

📦 Core Technologies

• 🐍 Python + FastAPI + SQLAlchemy
• 🐘 PostgreSQL + Alembic (Migrations)
• ⚛️ React + TypeScript + Vite
• 🐳 Docker + Docker Compose
• 🛠️ DevContainer for consistent development environments.

🧱 Project Structure

.
├── .devcontainer/  # DevContainer configuration
├── backend/        # FastAPI source code
├── frontend/       # React + Vite source code
├── local-running/  # Docker Compose orchestration scripts
├── setup.sh        # Initial setup script
└── README.md

🚀 Getting Started

📋 Prerequisites

• Docker & Docker Compose.
• Visual Studio Code + Dev Containers extension (highly recommended).

⚙️ Installation

1. Clone the repository:

   git clone git@github.com:SebaB29/MyFiubaGymBro.git
   cd myFiubaGymBro

2. Environment Variables:
   Create a .env file in the backend/ folder:

   DATABASE_URL=postgresql://postgres:secret@db:5432/myfiubagymbro

💡 Usage

🧪 Local Development (DevContainer)

1. Open the project folder in VS Code.
2. Click "Reopen in Container" when prompted (or use Ctrl+Shift+P → Dev Containers: Reopen in Container).
3. Services will be available at:
   • Backend: http://localhost:8000
   • Frontend: http://localhost:8080

🛠️ Manual Backend Setup

cd backend
pip install -r requirements.txt
alembic upgrade head
fastapi run src/main.py --port 8000

• API Docs: http://localhost:8000/docs
• Tests: Run pytest inside the backend folder.

💻 Manual Frontend Setup

cd frontend
npm install
npm run dev

• Access at: http://localhost:8080

🐳 Docker Compose

To run everything without DevContainers:

./start.sh   # Starts all services
./stop.sh    # Stops all services

🤝 Contributing

1. Fork the project.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the Branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

👥 Team

Nombre	Usuario de GitHub
Sebastián Brizuela	@SebaB29
Federico Solari	@FedericoSolari
Luciano Gamberale	@lucianogamberale
Joaquín Velurtas	@joaquinvelurtas
Santiago Rocco	@SantiagoRocco

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.