Skip to content
/ gymn Public

WIP - One app, two perspectives. Manage your Gym, or track your personal workouts in a single place.

Notifications You must be signed in to change notification settings

risixdzn/gymn

Repository files navigation


Gymn

One app, two perspectives. Manage your Gym, or track your personal workouts in a single place.
Experience it! »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Run locally
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

💪 About The Project

Gymn is a webapp made with the purpose of being used by any fitness enthusiast, ranging from a gym owner, that can manage his gym, until a gym rat, that can handle his workout routing seamlessly.

Built With

Next React Supabase Postgresql Tailwind Shadcn-ui

💻 Run locally

As the database schema is kinda complex, having lots of relations and internal postgres scripts, you should just use the app at https://gymn.vercel.app and avoid having mental issues 🤣

🏋️ Usage

Gymn's purpose is to be used as a:

  • Workout tracking app
    • Users can create and track their workout routine, creating their own workouts.
    • They also can organize their favourite exercises.
  • Gym management app
    • Gym owners accounts can create gyms and affiliate users
    • The gym affiliate users have access to specific workout routines planned by their personal.
  • Gym social media
    • All of this can be shared via posts
    • You can have a profile and post your workout routine and inspire others to workout with you.

(back to top)

🛣️ Roadmap

  • [☑️] Authentication
  • [☑️] Dashboard
  • [☑️] Profile page
  • [☑️] Exercise listing and creation
  • [☑️] Workout creation
  • [ - ] Gym management
  • [ - ] Social media stuff
  • [ - ] Internationalization
    • [ ☑️ ] Portuguese PT_BR
    • [ - ] English EN_US

See the open issues for a full list of proposed features (and known issues).

(back to top)

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

✉️ Contact

Ricardo Amorim - @risixdzn - [email protected]

(back to top)