Learn how to code from artists. Comuse is an educational platform for learning code where the classes are created and taught by artists. For demo instructions, see step by step walkthrough below.
Comuse uses Ruby on Rails as the framework for building the backend. Comuse leverages sqlite3 as the database for Active Record. The frontend of the application is built using React providing the UI for members to fetch and change data from the backend.
This API is deployed on Heroku and can be found here: https://comuse-backend.herokuapp.com
For authentication functionality Comuse uses the bcrypt gem and JSON Web Tokens. For payment functionality Comuse uses the Stripe API and Bootstrap's Leap Template for the frontend UI.
The frontend for this application is deployed on Heroku and can be found here: https://comuse.herokuapp.com/
The GitHub repository for the frontend of this application can be found here.
JSON data can be viewed at the various namespaced routes:
- https://comuse-backend.herokuapp.com/api/v1/members
- https://comuse-backend.herokuapp.com/api/v1/section
- https://comuse-backend.herokuapp.com/api/v1/course
- https://comuse-backend.herokuapp.com/api/v1/category
- https://comuse-backend.herokuapp.com/api/v1/enrolled
And more...navigate to config/routes.rb to view remaining routes.
In order to demo this application
Test User
Email: info@zolajones.com
Password: pw
Test Card
Card Number: 4242 4242 4242 4242
- Log in as "demo member", Zola Jones
- Head to "Classes" in the menu and view all classes in the database
- Search a class by keyword (Ex: "Code")
- Click on a course you are not already enrolled in and enroll using the test credit card number, any valid expiration date, any CVC, and any zip code. Notice how you now have access to the course's lessons. The payment of this new enrollment will now be visible on the respective teacher's payment dashboard.
- Click "Logged in as: Zola Jones" to reveal drop down menu
- Click "My Profile" to view your profile, edit your profile, create a new class, view classes Zola's teaching, and view classes Zola's enrolled in
- Click on one of the classes you're teaching and click the "Edit" button next to one of the lessons to activate "Edit Lesson" modal
- For each course you've created you can also edit the class and add lessons to the class. Each lesson has the option to include a YouTube video.
- Click "Payments Dashboard" to view your payments profile, connected cards, balance activity, and upcoming payouts from students enrolled in your class.
- When finished with this demo, logout using the drop down submenu within the main menu.
-
Ruby version: 2.6.0
-
Database creation:
rake db:setup -
Application initialization:
rails s
To install Comuse, fork and clone this repository on to your local machine.
Run the following line to install all gems, migrate the database, and seed the databased with initial data:
bundle install && rails db:migrate && rails db:seedIf this is unsuccessful, you may need to create the database, load the schema, and initialize with the seed data using:
rake db:setup Initialize the server:
rails sPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.