New Zealand legislation contains a somewhat complicated requirement to obtain citizenship by grant. The applicants needs to be present in New Zealand, on an indefinite stay visa, for a total number of days over a time. For a person who has travelled outside NZ this can result in being eligible for a small window of time, and then ineligible again.
This software is a tool to calculate and predict days where a person is eligible, helping people decipher the result of these rules in legislation, and plan.
The rules are implemented on an OpenFisca server.
This app is built to run on Linux, but also runs nicely on MacOS. Windows is not supported, so YMMV.
This is a ruby on rails app. You will need to:
- Git clone this repo
- Install the correct version of Ruby. We recommend installing
rbenvto manage multiple versions of ruby, and then using that to install the version of ruby specified in our file.ruby-version
# Install rbenv from https://github.com/rbenv/rbenv then
rbenv install < .ruby-version
- Install PostgreSQL (in a mac)
brew install postgresql
- Start PostgreSQL on startup
brew services start postgresql
- Bundler. Install this from gem
gem install bundler
- Install the gems needs by this app:
bundle install
- Install the javascript dependencies
yarn install
- setup config environment variables from the example
cp env-example .env
- Create the databases
bundle exec rake db:create db:migrate
- Create the first user
bundle exec rake db:seed
- Run the app
bundle exec rails server
Deployments happen automatically (performed by TravisCI) when code is merged into the master branch.
RSpec
bundle exec rspec
Rubocop
bundle exec rubocop
Generate a PDF diagram of the database structure (rails-erd gem) in the root folder of the application (requires Graphviz):
bundle exec rake erd