https://github.com/javascriptizer1/gymnote
Gymnote Telegram Bot [Golang, Clickhouse, Redis, TgBotAPI]. Track your progress
https://github.com/javascriptizer1/gymnote
analytics backend bodybuilding bot clean-architecture clickhouse docker-compose fitness-app go golang gymnote makefile redis telegram telegram-bot telegram-bot-api training
Last synced: 6 months ago
JSON representation
Gymnote Telegram Bot [Golang, Clickhouse, Redis, TgBotAPI]. Track your progress
- Host: GitHub
- URL: https://github.com/javascriptizer1/gymnote
- Owner: javascriptizer1
- Created: 2025-01-18T16:53:53.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-04-05T14:35:31.000Z (9 months ago)
- Last Synced: 2025-04-05T15:29:06.767Z (9 months ago)
- Topics: analytics, backend, bodybuilding, bot, clean-architecture, clickhouse, docker-compose, fitness-app, go, golang, gymnote, makefile, redis, telegram, telegram-bot, telegram-bot-api, training
- Language: Go
- Homepage:
- Size: 42.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🏋️♂️ Gymnote Telegram Bot
GymNote is a **Telegram bot** designed to help users track their workout progress easily. With simple commands and an intuitive interface, users can log exercises, track progress over time, and stay consistent with their fitness goals.
## Features 🏋️♂️
- **Workout Logging**: Easily record your exercises with sets, reps, and weights.
- **Progress Tracking**: View statistics on past workouts.
- **Exercise History**: Retrieve past logs to analyze your improvements.
- **User-Friendly Commands**: Simple and efficient command structure.
## Preview
## Tech Stack ⚙️
- **Language**: Go (Golang)
- **Database**: Clickhouse
- **Cache**: Redis
- **Messaging API**: Telegram Bot API
- **Hosting**: Deployed on VPS
## Getting Started 🚀
### Prerequisites
Ensure you have the following installed on your system:
- Go (1.23.5)
- Docker & Docker Compose
- Make
### Setup Instructions
1. **Environment Configuration**
```bash
cp .env.example .env
```
2. **Start Services with Docker Compose**
```bash
make docker-up
```
3. **Run migrations**
```bash
make migrate-up
```
4. **Run the Bot**
```bash
make run
```
## Commands 📜
- **/start** - Start the bot
- **/help** - Show help
- **/start_training** - Start a new training session
- **/upload_training** - Upload a new training session
- **/get_trainings** - View training history
- **/get_exercise_progression** - View weight progression for an exercise
- **/create_exercise** - Create a new exercise
- **/clear_training** - Reset the current training session
## In action 🚀
### Start Training
Kick off your training session by choosing a muscle group. Whether it's chest, back, legs, or arms, GymNote guides you every step of the way.
### Choose Your Exercise
Browse through a curated list of exercises tailored to your selected muscle group. From bench presses to squats, find the right move for your workout.
### Log Your Sets
Enter your weight and reps for each set. GymNote also shows your exercise history, so you can easily pick the right weight and push your limits.
### Finish Strong
At the end of your session, get a detailed summary of your workout. See how many exercises you completed, the total volume lifted, and more.
### Track Your Progression
Monitor your progress over time with detailed charts. GymNote helps you stay motivated by showing how far you've come in each exercise.
### Training History
Access your complete training history. Review past workouts, analyze your performance, and plan your next session with confidence.
## Deployment ⚙️
The bot is deployed on a **VPS** using Docker and managed via **systemd** for uptime reliability.
## Contributing 🤝
Feel free to open issues, submit pull requests, and improve GymNote together! If you like the project, give it a ⭐ on GitHub!
---
Stay fit and keep logging your progress! 💪🔥