BandDB

Simplified Inventory Management & Digital Assistant for Band Directors

View Demo

Table of Contents

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

About The Project

BandDB is designed to be a simple, user-friendly database management system for secondary and post-secondary band directors. If you have used Charms in the past and struggled with it, then you need to check out BandDB!

Features of BandDB:

• Keep a digital Instrument Inventory and track which instruments are checked out to which students
• Digitize your music library!
• Assign Lockers to students and easily access their locker combination when they forget!

Built With

• React.js
• Ruby
• Sinatra
• SQLite3

Getting Started

To get a local copy up and running follow these steps.

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

Create a new directory on your machine and run the following commands in your terminal.

1. Clone the front-end repo in your root directory

   git clone https://github.com/stevehvaughn/banddb-frontend.git

2. Clone the back-end repo in your root directory

   git clone https://github.com/stevehvaughn/banddb-backend.git

3. Install NPM packages in the frontend directory

   npm install

4. Install Gemfile packages in the backend directory

   bundle install

5. Start the rake server in the backend directory

   rake server

6. Start the App in the frontend directory

   npm start

Usage

Students Tab

In the Students Tab you can see all of your students. On each student you can assign them a locker, and also easily access their locker combination if they forget it! You can also add new students using the form at the top of the page, or delete a student that is no longer attending your school.

Music Library Tab

In the Music Library Tab you can see all of the pieces you have in your library.

Instrument Inventory Tab

In the Instrument Inventory Tab you can see information about the instruments in the school such as condition, brand, model, and serial number.

Lockers Tab

In the Lockers Tab you see a full list of all the lockers in your room, and any students that are assigned to them. This can be another way to easily access locker information for a student.

Roadmap

I plan on refactoring this entire project in the future to implement a Ruby on Rails backend as opposed to a Sinatra backend. I also want to add user authentication for teachers to login and only see their students.

Contributing

Are you a 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. Add and Commit your Changes (git commit -am '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: Front-end Repo | Back-end Repo