Toaster – Speech Club Management

Description

Toaster is a tool for speech clubs to track club memberships, invitations, and requests to join. It is currently under development, and more useful features are planned, like the ability to organize meetings, and to track member progress.

Toaster is built with Ruby on Rails, and does not have dependencies on any external system except any database. It uses a Puma webserver, in place of the usual WEBrick, only because it is encouraged by Heroku, on which this app's reference implementation runs.

Documentation

Documentation for the features this application supports is written in Gherkin, so the most up-to-date high-level documentation can be found in this application's features folder.

Class-level documentation is hosted on Rubydoc.

Installation

This application uses Bundler for its dependencies. Use bundle install to install them. No additional work is necessary.

Contributing

See CONTRIBUTING.md for information on how to contribute to this project.

Metrics

Build

Build Status Dependency Status security

Documentation

Inline docs

License

Copyright © 2015 Robert Richter

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <www.gnu.org/licenses/>.

This application is not affiliated with nor endorsed by any speech club organization.