Skip to content

Azurioh/BaselHack-2024-GuideMe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

223 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GuideMe - AI-Powered Yoga Pose Assistant

A web application developed during BaselHack that helps users perfect their yoga poses through AI-powered pose detection and personalized instructions.

🎯 Overview

GuideMe analyzes your yoga poses through uploaded photos and provides detailed instructions to help you achieve the perfect form. Whether you're a beginner or an experienced yogi, our AI assistant guides you toward better practice.

🤖 AI Models

🌐 Deployment

  • Hosting: Application fully hosted on a VPS (Virtual Private Server)
  • Domain: Temporarily accessible at https://baselhack.azu-dev.fr/
  • Infrastructure: Both client and server running in Docker containers on the same VPS

🚀 Features

  • AI-powered yoga pose detection
  • Detailed pose correction instructions
  • Export instructions in PDF or DOCX format
  • User-friendly interface
  • Real-time feedback

💻 Tech Stack & Benefits

Frontend

  • React.js: Enables component reusability and efficient DOM manipulation
  • Ant Design (antd): Provides production-ready UI components, reducing development time

Backend

  • Express.js: Offers lightweight and flexible routing for fast API development
  • Prisma ORM: Simplifies database operations with type-safe queries and auto-completion
  • PostgreSQL: Ensures data integrity with ACID compliance and handles complex relationships efficiently

DevOps & Project Management

  • Docker: Ensures consistent environments across development and production
  • GitHub Actions: Automates testing and deployment processes
  • Docker Compose: Simplifies multi-container application management
  • Jira: Facilitates agile workflow with sprint planning and task tracking

🏗️ Project Structure

GuideMe/
├── assets/                 # Global assets
├── code/
│   ├── client/            # Frontend application
│   │   ├── public/        # Static files
│   │   └── src/
│   │       ├── assets/         # Frontend assets
│   │       ├── auth/           # Authentication logic
│   │       ├── components/     # React components
│   │       ├── lang/           # Internationalization
│   │       └── pages/          # Application pages
│   └── server/                 # Backend application
│       ├── ai/                 # AI pose detection logic
│       ├── prisma/             # Database schema and migrations
│       └── src/
│           ├── controllers/    # Route controllers
│           ├── entities/       # Data models
│           ├── services/       # Routes logic
│           ├── routers/        # Routes
│           └── middlewares/    # Middlewares
└── documentation/         # Project documentation

🔧 Setup & Installation

  1. Clone the repository:
git clone https://github.com/Azurioh/BaselHack-2024-GuideMe
cd BaselHack-2024-GuideMe
  1. Run with Docker:
docker-compose up --build

🔄 Development Workflow

Our deployment process is streamlined through GitHub Actions:

  1. Push to main branch triggers automatic deployment
  2. GitHub Actions rebuilds and redeploys Docker containers on our VPS
  3. Application is automatically updated with zero downtime

👥 Team

Project developed for the BaselHack 2024 hackathon.

BaselHack

About

Application for generating user guides from images | BaselHack hackathon challenge, 2024 edition

Topics

Resources

License

Stars

Watchers

Forks

Contributors