Feijoa

Overview

A Rails web app to demonstrate consent management

Environments

Environment	URL	Git Branch
production	https://feijoa.herokuapp.com/	master
staging	https://feijoa-staging.herokuapp.com/	staging

Project Resources

Resource	URL
Backlog	https://trello.com/b/1XoN2WJT/yeah-nah-feijoa
CI	https://travis-ci.org/ServiceInnovationLab/feijoa

Role(s)	Name(s)
Team	Yeah Nah / Feijoa
Developers	@br3nda, @lamorrison, @mermop, @JacOng17
Designers	@rosspatel01
Testers
Scrum Master	@merridy
Product Owner	@workbygrant

Comms

Slack: LabPlus-team #feijoa

Setup

Prerequisites

Postgres
Java
Selenium & ChromeDriver

Development

In the application directory:

1. Make a copy of the example environment file containing some important settings

cp example.env .env

2. Install Rails dependencies and create local databases

bin/setup

3. Install and run Elastic search

By default this is expected to run on localhost:9200 - if you have ElasticSearch running on a different port, you can change ELASTICSEARCH_URL in your .env file.

On Ubuntu you can use the same script as Travis CI:

ELASTIC_SEARCH_VERSION="6.2.3" ./bin/install_elasticsearch.sh

On Mac you may want to use Homebrew:

brew install elasticsearch
brew services start elasticsearch

To check whether Elastic Search is running (or not) service elasticsearch status

4. Create a search index in Elastic Search

You will need to build an ElasticSearch index for the new organisations:

bundle exec rake search:index

5. Start a local server

bundle exec rails server

Local data

You can import organisations

bundle exec rake import:ece
bundle exec rake import:schools
bundle exec rake import:tkkm

Testing

Rubocop

bundle exec rubocop

Rspec

bundle exec rspec

Test coverage is reported to coverage/index.html

Script to create users/organisations, etc...in terminal:

rails runner bin/user_seed

Manually creating users/organisations, etc...in rails console:

To create a user to login:

user = FactoryBot.create :user, email: '<emailAddress>', password: '<password>'

To create an organisation:

organisation = FactoryBot.create :organisation

To add user to an organisation: (add_role(organisation, role) method from user.rb)

Eg. user.add_role(organisation, OrganisationMember::ADMIN_ROLE)

Adding Birth Records & Immunisation Records

Add the Birth Records & Immunisation Records to the user (as many as you want from the 10 generated) by clicking on Add a document.

Requesting & Sharing documents

Click on the Your organisations dropdown & select the organisation from the list. From there, click on Request a document, enter the appropriate information (for testing purposes, you can just enter 123@123.nz for the Recipient's email) then click Create Request.

Click on the Your personal data dropdown & select either My Dashboard OR Requests from the list to see the requested document (from the organisation).

Click either Respond OR Decline.

If you had clicked on Respond, select the birth record that you want to share by clicking on the Share button. To confirm that the share was successful, navigate back to the organisation & you should see the shared document in the Received documents area.

ServiceInnovationLab / feijoa