Citizenry is a simple, friendly web application for communities to keep track of the people, companies, groups, and projects that make them great.
It was originally built to power http://epdx.org/, and this fork is used as a guide for the awesome tech community of Pittsburgh, Pennsylvania.
Citizenry is written in Ruby 1.8.7, using Rails 3.
Check out this too, but it is newer than the version of citizenry we forked from:
- https://github.com/reidab/citizenry/blob/master/INSTALL.md
- https://github.com/alexknowshtml/We-Work-In-Philly/blob/master/README.markdown
PostgreSQL installation and upgrade procedures:
- http://www.postgresql.org/docs/9.1/static/install-procedure.html
- http://www.postgresql.org/docs/9.1/static/upgrading.html
Citizenry installation guide
============================
Prepare
-------
I'm running on Mac OSX 10.8, so the steps for me were:
1. Install git and ruby (by [installing Xcode](https://itunes.apple.com/us/app/xcode/id497799835)
* Note: make sure to enable the command line tools in Xcode menu > Preferences > Downloads
1. Already had rubygems installed (v1.3.x or newer), so nothing to do there.
1. Install brew
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
1. Install ImageMagick
brew install imagemagick
1. Checkout the source code.
git clone https://github.com/sidwiesner/WeWorkInPittsburgh.git
Development
-----------
### Development using local machine
You will need to install more software to do development on your local machine:
1. [Install PostgreSQL](http://www.postgresql.org/), a database engine. Your operating system may already have it installed or offer it as a pre-built package.
brew install postgres
1. [Install Bundler](http://gembundler.com/), a Ruby dependency management tool.
sudo gem install bundler
1. Install the Postgres gem
sudo env ARCHFLAGS="-arch x86_64" gem install pg -v '0.11.0'
1. Install other gems
bundle install
1. Configure the database settings in the `config/database.yml` file as needed.
1. Configure the application settings in the `config/settings.yml` file as needed.
1. Create database
initdb /usr/local/var/postgres
createdb citizenry_dev
createdb citizenry_test
1. Start PostgreSQL (see below for instructions). PostgreSQL is not required to setup a dev box, but then cannot import production database as easily
1. migrate database
bundle exec rake db:migrate
1. create database, migrate, and prepare db tests
bundle exec rake db:create db:migrate db:test:prepare
Running the Citizenry application:
* Start the *Ruby on Rails* web application
bundle exec ruby script/rails server
* Open a web browser to <http://localhost:3000/> to use the `development` server.
* To stop the server, go to the terminal and press `CTRL-C`.
Set up:
~/.profile
export APP_SECRET=''
export S3_BUCKET=''
export S3_KEY=''
export S3_SECRET=''
# Install Postgresql - I do not remember if I specified the 32-bit
brew install postgresql --32-bit
# rvm and ruby setup, I needed --with-gcc=clang for Snow Leopard and XCode 4.2 incompatibility
rvm install ruby-1.8.7-p370 --with-gcc=clang
# clone git repository, set remotes, staging is cera's staging server
git clone git@github.com:sidwiesner/WeWorkInPittsburgh.git
cd WeWorkInPittsburgh
git remote add production git@heroku.com:cold-fog-145.git
git remote add staging git@heroku.com:shrouded-retreat-7570.git
# switch to staging branch
git checkout staging
# IMPORTANT - prevents accidents, sets the default remote
git config heroku.remote staging
# installs missing dependencies
bundle install
If this is your first install, automatically load on login with:
mkdir -p ~/Library/LaunchAgents
cp /usr/local/Cellar/postgresql/9.1.3/homebrew.mxcl.postgresql.plist ~/Library/LaunchAgents/
launchctl load -w ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
If this is an upgrade and you already have the homebrew.mxcl.postgresql.plist loaded:
launchctl unload -w ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
cp /usr/local/Cellar/postgresql/9.1.3/homebrew.mxcl.postgresql.plist ~/Library/LaunchAgents/
launchctl load -w ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
Or start manually with:
pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start
And stop with:
pg_ctl -D /usr/local/var/postgres stop -s -m fast
To add a column to a table, use database migrations. Generate a migration using the following with the appropriate table and column names:
rails generate migration AddNumberOfEmployeesToCompanies number_of_employees:integer
The above command will create a file in db/migrate. Then migrate the db with:
bundle exec rake db:migrate
The new column should now be in the db and model. More information on migrations can be found here.
$ heroku run rake db:migrate --app=wwip-staging
# setup environment variables
. cera-dev/dev.sh
# DANGEROUS - clean database
bundle exec rake db:drop db:create db:migrate
bundle exec rake db:drop db:create db:migrate db:test:prepare
# test that database is accessible
echo "select * from companies" | psql citizenry_dev
# Make sure configuration files setup correctly
cat config/database.yml
cat config/settings.yml
# start rails
bundle exec ruby script/rails server
# import production to local database
curl -o latest.dump `heroku pgbackups:url --remote=production`
pg_restore --verbose --clean --no-acl --no-owner -d citizenry_dev latest.dump
# push staging branch to origin remote. Basically publish to github.
git push origin staging
# fix if somebody deployed to production remote, but never committed to main source tree
git fetch production
git merge production/master
# deploy to staging environment, branch is also called staging
# -f is normal since this branch is used solely for transport
git push -f staging staging:master
# Restart heroku server
heroku ps:restart --app shrouded-retreat-7570
# Switch databases (needed if you upgrade from freemium databaase to store >10k records)
heroku pg:promote HEROKU_POSTGRESQL_IVORY
# install addon for backups
heroku addons:add pgbackups:auto-month --app shrouded-retreat-7570
# backup production db
heroku pgbackups:capture --app cold-fog-145
# connect to remote database to make sure it's the right one
heroku pg:psql --app shrouded-retreat-7570
# restore the last snapshot of production to staging
heroku pgbackups:restore DATABASE `heroku pgbackups:url --app cold-fog-145` --app shrouded-retreat-7570
$ heroku apps:create
heroku maintenance:on --app cold-fog-145
League Gothic from the Leage of Movable Type http://www.theleagueofmoveabletype.com/fonts/7-league-gothic