Record and triage needs, get people the right support
🚨This is BETA software. Please submit issues for any bugs you find.🚨
This is a tool for local authorities and voluntary organisations to record and triage the needs of shielded people in their jurisdiction, and assign those needs to those who can meet them. Learn more at beacon.support.
It deals in:
- 👩💻 people in need, who might be added by contact centre staff
- ✅ needs, which can be created under a person in need, given a need type and claimed by users
- 👩🔬 users, invited by email address whitelisting
It's a rails app backed by a postgresql database.
Follow these steps to build the database and app
docker-compose build app
docker-compose run app bin/rails db:setup
At this point you may get an error:
error Couldn't find an integrity file
error Found 1 errors.
Your Yarn packages are out of date!
Please run `yarn install --check-files` to update.
If so, then run the following:
docker-compose run app yarn install --check-files
Once you have run this, re-run docker-compose run app bin/rails db:setup and then:
docker-compose up
The site will now be available on https://localhost:3000
More details on how to use and install Beacon with Docker can be found in the DOCKER-README
docker-compose run app rake
docker-compose up
git clone https://github.com/wearefuturegov/i-have-i-need
bundle install
# install javascript dependencies
yarn install
# launch postgres server via docker
docker-compose up -d postgresql
# run create databases, run migrations and seeds
rails db:setup
rails server
It'll be on localhost:3000.
You can log in using [email protected].
Emails use GovUk notify. You can view the email text sent in the log in development, including magic sign in links
# to set git hooks
i-have-i-need$ git config core.hooksPath .githooks
# check for X permissions. Here is what you need:
i-have-i-need/.githooks$ chmod +x pre-commit
i-have-i-need/.githooks$ chmod +x pre-commit.d/01-rubocop
Suitable for 12-factor app hosting like Heroku.
Sendgrid delivers emails in production. You need to make sure the API key environment variable is set.
It has a Procfile that will automatically run pending rails migrations on every deploy, to reduce downtime.
Navigate to the note model (app/models/note.rb) and within the CALL_TITLE constant add the new category string.
Coming soon...
| Name | Description |
|---|---|
| COUNCIL | Config key for councils.yml |
| NOTIFY_API_KEY | Gov.uk Notify API key (production only) |
| HOSTNAME | Hostname used in outbound emails (e.g. x.beacon.com). Defaults to heroku app name |
| SEED_USER_EMAILS | Optional comma-separated list of emails to seed users table with |
| GA_PROPERTY_ID | Optional Google Analytics property ID |
| LINK_EXPIRY_MINUTES | Magic link expiry time in minutes |