CircleOfHope / circlemusic

A music catalog app aimed at churches
0 stars 0 forks source link

Circle of Hope Music Catalog

This repository is for the official rewrite of the Circle of Hope Music Table.

Introduction

This applicaion serves as a hub of all things music at Circle of Hope. It's primary purpose is to catalog the songs we sing in our congregations and cells.

Why a rewrite?

The Music Table has served us well for the last 5 years. It was a fantastic upgrade from the Google Spreadsheet we were using to maintain our music catalog. Even so, there are still many leaders who opt not to use it, in addition to the feedback and feature requests we've gotten for improvement.

The original application was written in a somewhat outdated framework. This makes adding new features and making improvements a bit more sluggish and difficult. By rewriting the code base, we are hoping to make iterative improvements easier, bigger feature requests more viable, and contribution more open.

Goals

As stated above the goals of the new application are:

Getting Started

In order to run the project locally, you will need to have Node JS and MongoDB installed.

Installation

Clone this repo and then run npm install from the project folder.

Running the app

From the project folder, simply type npm start.

Importing old data

If you have a copy of the legacy database accessible, you can import the data into MongoDB using the bin/import script. Type bin/import --help to see required options.

Contributing

Contributions are welcome. We try to follow Thoughtbot's Git Protocol.

We are also discussing our progress in the Circle of Hope Slack channel. If you need an invite for our team, create an issue in this repo and we'll get you one.