joyvuu-dave/gather

A fun, responsive, secure app for managing a cohousing community!

Gather

A cohousing meals management system.

Platform

Gather is a Ruby on Rails application with some client-side JavaScript for dynamic view elements. HTML is generally rendered server-side. SCSS is used for styling. No special IDE is required for Ruby on Rails development.

Ruby on Rails applications are best developed and run on Linux, Unix, or Mac OS. Development is also possible, though not recommended, on Windows. See the Rails download page for more information.

Package Managers

To install the software below we recommend the following package managers:

• Mac OS X: Homebrew
• Linux/Unix: bundled package manager (e.g. apt-get, yum)

System dependencies

1. Ruby v2.2.x (see .ruby-version file for exact version, rbenv is recommended for Ruby version management)
2. Bundler
3. Once Ruby is installed, run gem install bundler to install.
4. PostgreSQL v9.2+ (database)
5. ImageMagick
6. Set up a Gather OAuth client, if you don't have one, on Google Developers.

Development Setup Guide

Follow these steps to setup a development environment for Gather.

1. Install all above dependencies

2. Retrieve project files using Git

git clone https://github.com/sassafrastech/gather.git
cd gather

If developing, it's best to work off the development branch:

git checkout develop

The remaining steps should all be done from the project directory.

1. Install gems

2. Run bundle install to install the required gems.

3. Set local config

4. Copy config/settings.local.yml.example to config/settings.local.yml.rb.

5. Edit config/settings.local.yml to fit your environment.

6. Create development and test databases and schemas

7. Copy config/database.yml.example to config/database.yml.

8. Run rake db:create to create mess_development and mess_test databases.

9. Run rake db:schema:load to create the schema in both databases.

10. Create a user so you can sign in

11. Run rake fake:user_data to add one community, one household, and one user (with admin privileges and your GMail address) to the gather_development database.

12. Run the tests

13. Run bundle exec rspec.

14. All tests should pass.

15. Start the server

16. Run bundle exec rails s.

17. Leave this console open.

18. Start DelayedJob

19. Open a new console.

20. Go to the project directory.

21. Run bin/delayed_job start.

22. Start using the system

23. In a browser, go to http://gather.localhost.tv:3000 to start Gather.

24. Click "Sign in with Google" to use Gather as the user you just created.

25. Enjoy!