MSTC App

Multiple Sclerosis Therapy Centre Client, Resource and Therapy Session Management

An open source, Ruby on Rails project to provide Multiple Sclerosis Therapy Centres an integrated tool to manage clients, resources and oxygen therapy sessions. Please see Use Cases in the wiki for a view of where this project will be going and GitHub issues for the user stories that have been prioritised for development.

Initially created for the MS Therapy Centre Lothian http://www.mstc-lothian.org.uk/

The software is intended to be run onsite on a dedicated Linux based server but can also be run in the "cloud" (for a demo, please see the latest version running on Heroku).

Pull requests and bug reports are always welcome!

Contents

• Installation
• Contributing

Initial Developmet

Text files have been created (found under ./doc/) giving a very basic listing of features that are required or desired. These documents should provide a general idea of the controlers and data fields which need to be created.

Installation for Development

Requirements

Before you get started, the following needs to be installed:

• Ruby (Linux) 2.5.1
• Ruby (Windows) 2.2.5 - Will probably need the DevKit and Node.js.
• RubyGems
• Bundler: gem install bundler
• Git

Grab the code:

git clone git://github.com/kmclellan/mstc.git

Install the dependancies:

cd mstc
bundle install

Initiate your development database:

bundle exec rails db:create
bundle exec rails db:migrate

(Currently do not have a schema to load.)

To view the application run a Rack webserver. In production this will be Phusion Passenger (simple and reliable deployment). For development I am currently using Puma.

bundle exec puma

http://localhost:3000

Contributing

Please see CONTRIBUTING.md for more detail.

• Fork the repository using GitHub.
• Clone the repository to your local development space.
• Checkout a branch, named after the feature you will be adding, created from the master branch.
• Write tests using minitest.
• Complete modifications or corrections.
• Run the tests, ensuring they all pass. (See TESTING.md)
• Commit your improvements.
• Pull the latest master to your feature branch and resolve any conflicts.
• Push your feature branch to your fork on GitHub.
• Contact lead developer, describe work done, submit a Pull Request using GitHub.

If you have direct access to the repository then develop in a branch before merging to master. DO NOT DEVELOP IN THE MASTER BRANCH.

License / Copyright

The software is released under an open source MIT license (please see copyright file).