Skip to content

SQ77/spinShare

Repository files navigation

Contributors Forks Stargazers Issues LinkedIn


Logo

SpinShare

Spin schedule sharing web app
Report Bug · Request Feature

Table of Contents
  1. About SpinShare
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments

About SpinShare

SpinShare screenshot


SpinShare is a schedule sharing web app for users to create, edit and share their spin schedule. Inspired by the hassle of individually asking friends for their schedules, SpinShare simplifies the process by providing a centralized platform where users can share and view each other's spin class times, making coordination and planning much more convenient.

(back to top)

Built With

  • React
  • TailwindCSS
  • Vite
  • NodeJS
  • Firebase

(back to top)

Getting Started

  1. Go to the SpinShare website
  2. Create an account by signing in with Google
  3. Add classes to your schedule
  4. Share them with friends

(back to top)

Usage

Home Page

When you visit the SpinShare website, you'll be greeted by this page. Here, you can view the Absolute, Ally, and Revolution schedules for the current week and explore the main features of SpinShare. Simply click the "Sign In With Google" button to log in to your account.

SpinShare login

Add Class

This feature offers two modes for adding a class.

  • Manual mode: Fill out a simple form with details like the class name, instructor, date, time, and location.
  • Image upload mode: Quickly add a class by uploading an image of your class bookings.

SpinShare Add Class

SpinShare Add Class

(back to top)

Roadmap

  • Schedule displaying classes
  • Add and edit classes
  • View past and upcoming classes
  • Friend system
    • Send friend requests
    • Add and remove friends
    • View friends' classes in your schedule
    • Invite friends to join classes
  • Absolute, Ally, and Revolution schedules (updated weekly)
  • Add classes to schedule from image (Absolute spin)
  • Add classes to schedule from image (Other studios)

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)

Top contributors:

contrib.rocks image

Contact

Shiqi - Admin email

Feedback Form: Help to improve spinShare!

Project Link: https://github.com/SQ77/spinShare

(back to top)

Acknowledgments

(back to top)

Releases

No releases published

Packages

No packages published

Languages