Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.15 KB

README.md

File metadata and controls

43 lines (30 loc) · 2.15 KB

Identity Kooragang

A rails engine which integrates with Identity to facilitate bi-direction data flow between Identity and Kooragang.

Created and maintained by GetUp!

Current stable version is [0.1.0]


These instructions should get you up and running with Identity Kooragang gem locally for development and testing.

Local Development

When developing this engine alongside Identity you'll need to reference where to find the local repository to identity bundler.

  • From within the host identity app cd /path/to/identity
  • Setup bundle reference to the local repo bundle config --local local.identity_kooragang /path/to/identity_kooragang
  • When you're done unset bundle config --delete local.identity_kooragang

System dependencies

PostgreSQL

OSX:

  • You can use Postgres.app (which is simpler to upgrade than a homebrew install). Note: this allows you to connect to Postgres locally without an empty username and password.

Linux:

  • sudo apt-get install postgresql libpq-dev
  • sudo -u postgres psql -c "create role username with SUPERUSER login password 'password'", replacing username and password with the ones you want to use for the app.

Ruby

Install the version of Ruby referenced in the Gemfile using a version manager/installer like chruby and ruby-install

Project setup and configuration

These commands assume you're in the project directory, and have the right version of ruby in your path.

  • Checkout the project from git
  • Install bundler: gem install bundler
  • Install project dependencies: bundle install
  • Copy .env.development.sample to .env.development, and populate the required settings

Running the test suite

  • Copy .env.test.sample to .env.test, and update the DATABASE_URL
  • Create a test database: createdb identity_kooragang_test_host; RAILS_ENV=test bundle exec rake db:migrate
  • bundle exec rspec runs all the tests