Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.67 KB

README.md

File metadata and controls

31 lines (21 loc) · 1.67 KB
Raw

Repertoire Keeper

Performing music groups of all sizes and configurations desire to track the repertoire they have performed. There are several reasons to organize this information

  • Ensuring a program isn't repeated to frequently
  • Identify favorite works and those not performed as often
  • Re-create an anniversary concert
  • Simply to know what has been performed!

Repertoire Keeper grew out of many people wondering aloud over the years how to track this information. As a developer, I had added this question to those I ponder in my downtime and found an opportunity with this technology stack to try out one of those ideas.

Install Instructions

  1. Install Rails 6.0
  2. Clone this repo to your local machine
  3. In the backend directory
    1. Run rails db:migrate to install the database
    2. Run rails s to start the server; the Rails API will serve on localhost:3000 but there is no need to access the backend unless you would like to review the JSON data itself
  4. In the frontend directory
    1. Open index.html in your browser

Contributor's Guide

Thank you for your interest in contributing to this project. Contributions are expected to be thoughtful, kind, explore new possibilities and add value to the application for all users.

If you have an idea or issue fix that you have not seen contributed or completed, please open a pull request with a meaningful message for review.

You will need to install the project, following the installation instructions, to ensure you are able to view and work with the source code.

License

This application carries an MIT License