Yoga Class Creator (YCC) is an app to help you craft pose sequences for your yoga classes.
-
Clone or download the repo: https://github.com/cyantis/yoga_class_creator
-
In your terminal, navigate to the app's directory and execute:
$ bundle
to install dependencies.
-
To create and seed the database, type:
$ rails db:migrate
and then:
$ rails db:seed
-
Launch a local server by executing:
$ rails s
and then visit http://localhost:3000
in your browser to access the YCC site.
To end the server session, type ctrl-c
.
To use the Open Authentication feature that allows users to login with their Google account you will need to:
-
Visit
https://console.developers.google.com
-
Create/select your project.
-
Navigate to 'Credentials', then select the 'OAuth consent screen' tab on top, and provide an 'EMAIL ADDRESS' and a 'PRODUCT NAME'
-
Create a
.env
file at the root of your app and add your Client ID and Client Secret to the.env
file like this:
GOOGLE_CLIENT_ID=Client ID Goes Here
GOOGLE_CLIENT_SECRET=Client Secret Goes Here
First time users ("Teachers") will need to create an account via a username, email, and password or, if setup, login with their Google account. Returning Teachers login via their username and password or Google account.
Once logged in, a Teacher's previous classes will be displayed. From this home page, the Teacher can:
- Create a new class by clicking
New Class
. Classes require aClass Title
andClass Type
and have optional fields forPlaylist
andPoses
. - View a previous class by clicking on the class title.
- End the session by clicking
Logout
.
By visiting a previous class page, the Teacher can:
Edit
orDelete
the class.- Return to the home page (
Back to Classes
). - Add date-stamped notes to the class (
Add Note
).
Once a note has been added to a class, the Teacher can:
- Edit the note (
Edit Note
). - Delete the note (
Delete Note
).
Whether creating or editing a class or note, Teachers always have the opportunity to Cancel
any additions/changes.
Clicking Logout
from anywhere in the app ends the Teacher's session.
Bug reports and pull requests are welcome on GitHub at https://github.com/cyantis/yoga_class_creator.
The gem is available as open source under the terms of the MIT License.