Lessonbook

An App for private music teachers and studio professors to manage their students' progress.

View Demo | Visit Lessonbook

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgements

About The Project

The idea for this app came to me while teaching lessons to my students at the University of Northern Colorado. I always keep a notebook to track my students' progress in lessons including their assignments, grades, and repertoire and I thought that having a way to manage my studio digitally would be incredibly useful. Lessonbook is a digital tool do just that, and it can be used by both teachers and students!

Features of Lessonbook:

• For teachers, having a single space dedicated to tracking your students lessons is incredibly time saving!
• For students, you can keep a practice log to make sure you are working on the materials each day for your next lesson!
• Students and Teachers can both leave comments on an individual lesson to ask questions, clarify an assignment, or leave an encouraging note!

Built With

• Ruby on Rails
• React.js
• Redux

Getting Started

This project is deployed on Heroku and can be visited at https://lessonbook.herokuapp.com
To get a local copy up and running follow these steps in the root level of the directory.

Prerequisites

• npm

  npm install npm@latest -g

• ruby
  You might already have ruby installed, run this to check

  ruby -v

  If you don't have ruby, check this documentation for how to install it

Installation

1. Clone the repo

   git clone https://github.com/stevehvaughn/lessonbook.git

2. Install Gemfiles

   bundle install

3. Install NPM packages

   npm install --prefix client

4. Start the rails server

   rails s

5. Start the node server

   npm start --prefix client 

Usage

Creating an Account

When you click the "Sign Up" button in the Navbar you are presented with a sign up form. When prompted with the "Student or Teacher" question if you choose Teacher the website will create your account as a teacher. If you choose Student you are promped with more questions so the database knows who your teacher is and additional information only necessary for students.

Teachers

Creating Lessons

While you are in a student with a lesson, click the "New Lesson" button. Here you can fill out information such as repertoire, objective, and assignment for the student to view. Be sure to select your student in the drop down menu before creating the lesson as well.

Viewing Lessons

You can view lessons that you have created for your students by clicking the "Show Lessons" button. Hover over a lesson to see information about it, and click it to see a detailed view of that lesson.

Roadmap

In the coming weeks I plan on implementing the student-side features of this application. I am aiming for a launch date of January 2022 to use the App with the students in my current studio.

Contributing

Are you a private lesson teacher who also codes? Do you want to contribute to this open-source project with your own ideas? Are you interested in this app and want to make it even better? Any contributions you make are greatly appreciated.

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

Contact

Steve Vaughn - GitHub | LinkedIn | Medium | Twitter | Email

Project Link: https://github.com/stevehvaughn/lessonbook

Acknowledgements

• Free Vector Musical Notes Pattern