Generate HTML code documentation in the doc directory by running rake doc:app
Get the code:
git clone https://github.com/mysociety/fixmytransport
In a terminal, navigate to the fixmytransport folder where this install guide lives.
You will also want to install mySociety's common ruby libraries. Run:
git submodule update --init
to fetch the contents of the submodule.
Configure the database:
Install Postgres and PostGIS - OSX installers are available at http://www.kyngchaos.com/software/postgres
- copy database.yml-example to database.yml in fixmytransport/config
- edit it to point to your local postgresql database in the development and test sections and create the databases:
Become the 'postgres' user (sudo su - postgres) (or whatever user postgres is running as)
psql template1 to get into command tool
\l to list databases
CREATE DATABASE fixmytransport_development encoding = 'UTF8'; CREATE DATABASE fixmytransport_test encoding = 'UTF8';
Make sure that the user specified in database.yml exists, and has full permissions on this database.
CREATE USER <username> WITH CREATEUSER; ALTER USER <username> WITH PASSWORD '<password>'; ALTER USER <username> WITH CREATEDB; GRANT ALL PRIVILEGES ON DATABASE fixmytransport_development TO <username>; GRANT ALL PRIVILEGES ON DATABASE fixmytransport_test TO <username>; ALTER DATABASE fixmytransport_development OWNER TO <username>; ALTER DATABASE fixmytransport_test OWNER TO <username>;
The following commands need to be run at the command line following db creation for each of fixmytransport_development and fixmytransport_test:
createlang plpgsql [database name] psql [yourdb] < /usr/local/pgsql/share/contrib/postgis-1.5/postgis.sql psql [yourdb] < /usr/local/pgsql/share/contrib/postgis-1.5/spatial_ref_sys.sql
Also, SRID 27700 (British National Grid) is incorrect in some installs of PostGIS. After you’ve installed and got a PostGIS template, log in to it and make sure the proj4text column of SRID 27700 in the spatial_ref_sys table includes +datum=OSGB36.
Install additional packages
If you're using a Debian-based system, you should make sure that the
packages listed in
config/packages are all installed.
To load a new binary Postgres dump file:
- Create the file from an existing database with
pg_dump -p [Postgres port number] --schema=public -Fc YOURDB > YOURDB.sql.dump
rake db:load_from_binary FILE=YOURDB.sql.dump
Running the tests
If you want to run the RSpec tests continuously while developing, you can do this using ZenTest. You can install ZenTest and support for Rails with:
gem install ZenTest autotest-rails
Then you can run the following command in the fixmytransport directory:
If you see many gem-related deprecation warnings when running the tests, such as:
NOTE: Gem.source_index is deprecated, use Specification. It will be removed on or after 2011-11-01. Gem.source_index called from /home/mark/fixmytransport/config/../vendor/rails/railties/lib/rails/gem_dependency.rb:21.
... then your version of RubyGems is much more recent that the
components of Rails in the
vendor subdirectory. One solution to
this is to downgrade to an earlier version of RubyGems with:
gem update --system 1.6.2