Skip to content
This repository has been archived by the owner on Mar 3, 2024. It is now read-only.

Latest commit

 

History

History
124 lines (75 loc) · 5.07 KB

README.md

File metadata and controls

124 lines (75 loc) · 5.07 KB
Raw

Big Help Mob - Community Powered Volunteering Flash Mobs

Big Help Mob is Youth Tree's latest project currently in development. The idea is simple: Regularly get together 100+ young people from all across the metro area in a big mob and do something useful for a local not-for-profit (tree-planting, renovating homeless shelters etc)... and then celebrate with enormous, ludicrous flash-mobs (100 people looking up at the sky in the CBD for no apparent reason... that sort of thing). (From the original Big Help Mob teaser / intro site)

About this Application

This app serves as registration and event management for each Big Help Mob event. The app is written on Rails 3 and the "Youth Tree Stack" - a common set of technology (haml, sass + compass, coffeescript + barista and a few other things).

The application uses git-flow, with the master branch being used for the current stable and develop being used for the next release. As such, deploying to production should always use master whilst deploying to staging shall always use develop.

Getting Started

To get started with this application, we assume you have an environment set up with rvm, mysql, git.

To install Big Help Mob itself, run the following:

git clone [email protected]:YouthTree/big-help-mob.git

Or, if you're not on the youthtree team,

git clone git://github.com/YouthTree/big-help-mob.git

Now, change into the directory.

cd big-help-mob

Note that it will ask you if you wish to trust the rvmrc. Inspect it to make sure it's ok and then accept it. Doing so, will do the following:

  • Install ree if not present
  • Create a bighelpmob gemset
  • Setup bundler in the gemset

Essentially, it bootstraps an environment ready for the next step.

Before you continue, we need to create a user for the application. To do this, log in to the postgres psql command line (on my system with hombrew, this was a matter of psql template), and run:

CREATE USER bighelpmob WITH PASSWORD 'bighelpmob';

And either create the development databases manually:

CREATE DATABASE bighelpmob_development OWNER bighelpmob;
CREATE DATABASE bighelpmob_test OWNER bighelpmob;

Or just simply give the user CREATEDB permissions:

ALTER USER bighelpmob CREATEDB;

Now, you can run:

./script/configure

Which will guide you through:

  • Installing all of the gem dependencies
  • Configuring config/settings.yml
  • Configuring config/database.yml

Next, you'll want to load some data into your database. If you're on the team and have access to the server, run:

cap staging sync:down

Which will give you a cleaned version of the staging dataset. Otherwise, run:

rake db:setup

Which loads the schema and creates an initial user.

Working on CoffeeScript / JavaScript?

If coffeescript isn't installed and available, you should not edit javascript or coffeescript. To setup coffeescript, your simplest approach is:

  1. Install Node.js (to /usr/local preferrably) - See http://nodejs.org/#download
  2. Install NPM - Run sh < <(curl http://npmjs.org/install.sh)
  3. Run npm install coffee-script

Deploying

On the Big Help Mob team? Deployment should be a simple matter of:

  1. cap production deploy - Deploy from master to the production server, http://bighelpmob.org/
  2. cap deploy - Deploy from develop to the staging server, http://staging.bighelpmob.org/

For more access details, please contact the other members of the team.

Syncing the Database

Want to work with a copy of production / staging data on your local box? Assuming you have access the production server, you can do so by running cap [environment] sync:down where environment is staging or production.

If no environment is passed, the app defaults to staging. On import, To prevent accidental mass emails, all users emails are reset to [email protected].

To push your local database to staging, you simply do: cap staging sync:up.

Note, you can combine these to clone production to staging with the cleaned data set by running ./script/sync-db.

Contributing

We encourage all community contributions. Keeping this in mind, please follow these general guidelines when contributing:

  • Fork the project
  • Create a topic branch for what you’re working on (git checkout -b awesome_feature)
  • Commit away, push that up (git push your_remote awesome_feature)
  • Create a new GitHub Issue with the commit, asking for review. Alternatively, send a pull request with details of what you added.
  • Once it’s accepted, if you want access to the core repository feel free to ask! Otherwise, you can continue to hack away in your own fork.

Other than that, our guidelines very closely match the GemCutter guidelines here.

(Thanks to GemCutter for the contribution guide)

License

All code is licensed under the New BSD License and is copyright YouthTree. Please keep this in mind when contributing.