This repo is a Hack for Heroes app developed by | Daria Thompson | David Stewart | Kate Haffenden | Lila Walker | Patrick Oliver | Stephan Ellenberger | Tom Ratcliffe
Special thanks to Ben Gittins and Karlo de Guzman for their contributions at the start of the project.
Getting Started | Dependencies | Deployment | Criteria for Building the Project
Ensure you have the following setup on your machine:
- Bundle
- Yarn
- PostgreSQL
- ImageMagick
git clone this repository and cd into the directory.
Install dependencies:
$ bundle install
Create, migrate and seed the database:
$ rails db:setup
To run the project, start up the server:
$ rails server
Then navigate to localhost:3000 in your browser
This project relies on the following Rails Gems:
- Devise (for user authentication)
- CarrierWave (for image uploading)
- Fog-AWS (for image storage)
Our app is deployed via Heroku: click here
To setup your own deployment, first create an app on Heroku
Then setup image storage:
- Set up an AWS S3 account
- Create a bucket in S3
- Get your S3 access key id and secret access key
Add the following keys to Heroku - see instrtuctions
S3_KEY=<your-access-key-id>
S3_SECRET=<your-secret-access-key>
S3_BUCKET=<your-bucket-name>
| Models | Methods | State |
|---|---|---|
| User | sign_up, log_in, log_out | email, password, volunteer(boolean), name, telephone, location, bio, image |
| Interest | name | |
| UserInterests | user_id, interest_id | |
| Matches | user_id, volunteer_id |
As a user
So that I can connect with volunteers
I would like to sign up to Age UK Volunteer Matching
As a user
So that I can tell volunteers what I'm interested in
I would like to choose my interests from a selection during the sign up stage
As a user
So that I can match with volunteers
I would like to see a list of volunteers with similar interests
As a user
So that I can choose who to share my contact details with
I would like to select the match whom I want to connect with
As a volunteer
So that I can help out users
I would like to sign up to Age UK Volunteer Matching
As a voluteer
So that I can tell volunteers what I'm interested in
I would like to choose my interests from a selection during the sign up stage
As a volunteer
So that I can connect with matches
I would like to receive a notification containing my match's contact details