https://github.com/wearefuturegov/beacon
Platform for councils and voluntary orgs to manage supply and demand during the coronavirus pandemic
https://github.com/wearefuturegov/beacon
coronavirus government health postgresql rails
Last synced: about 1 year ago
JSON representation
Platform for councils and voluntary orgs to manage supply and demand during the coronavirus pandemic
- Host: GitHub
- URL: https://github.com/wearefuturegov/beacon
- Owner: wearefuturegov
- License: mit
- Created: 2020-03-26T08:56:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T20:37:47.000Z (over 3 years ago)
- Last Synced: 2023-08-24T21:59:05.613Z (almost 3 years ago)
- Topics: coronavirus, government, health, postgresql, rails
- Language: Ruby
- Homepage: https://beacon.support
- Size: 3.57 MB
- Stars: 4
- Watchers: 12
- Forks: 3
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://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.
## Running with Docker Compose
### Build
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-README.md)
### Run tests
```
docker-compose run app rake
```
### Run app
```
docker-compose up
```
## Running it locally
```
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 **admin@example.com**.
### How emails work
Emails use GovUk notify. You can view the email text sent in the log in development, including magic sign in links
### Git Hooks
```
# 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
```
## Running it on the web
[](
https://heroku.com/deploy)
Suitable for 12-factor app hosting like [Heroku](http://heroku.com).
[Sendgrid](https://sendgrid.com/) 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.
## Adding new categories manually
Navigate to the note model (`app/models/note.rb`) and within the `CALL_TITLE` constant add the new category string.
## Roadmap
Coming soon...
## Environment variables
| 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 |