Skip to content

AnimeshRy/gymrocket

Repository files navigation

logo

💪 GymRocket

The open source manager app specifically designed for gymnasiums.

APM GitHub Pipenv locked Python version GitHub issues GitHub forks

⚡ Features

🎯 Dashboard - Analytics on Member and Payment Data.

🎯 Member Manager - Create, Read, Update, Delete Member Data

🎯 Minimal and Sleek UI - Elegant Responsive Tailwind User Interface

🎯 Generate Reports and Import as CSV - Generate CSV with Member Data for external use.

🚀 Setup

These instructions will get you a copy of the project up and running on your local machine for deployement and development.

You'll need Git and Python 3.5+ installed on your local computer.

python@3.6 or higher
git@2.17.1 or higher

You can also use the Zip file and extract the folder.

🔧 How To Use

From your command line, clone and deploy:

# Clone this repository
$ git clone https://github.com/AnimeshRy/gymrocket

# Go into the repository
$ cd gymrocket

# Install dependencies
# if Pipenv available ? run
$ pipenv install

# Else
$ pip install -r requirements.txt

📨 Environment Setup

# You'll need some environment variables to setup.
touch .env
# replace string with a random string
SECRET_KEY={string}
DEBUG=True

🛠️ Django Setup

After installing the requirements, we'll need to setup some Django commands.

Perform database migration:

python manage.py check
python manage.py migrate

Create Admin Account

This is the manager account and only this user can login.

python manage.py createsuperuser
# follow instruction 

Run Development Server

python manage.py runserver

Navigate to http://localhost:8000/ endpoint in your browser.

Admin endpoint is at http://127.0.0.1:8000/admin/

👨‍💻 Technologies used

Frontend

Backend

📄 License

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

For the Future

If you want to contribute and make this much better for people, you are open to fork and develop it as your own.

  • Notification System
  • Fitness Plans

Designed & Developed with 💙 by Animesh Singh