Be sure to edit this file as things change…
A Rescue is an organization made up of People who are Volunteers and/or Fosters.
Anyone caring for an Animal is a Foster. Fosters must have a Home. Animals must have a Home.
An Animal will move from one Home to another and that may change their Foster.
That means that members of an organization who are administrators, are Fosters. They may have a shelter where an animal is housed, which is the animal's Home. Or those administrators may be housing an animal at their actual house, which will still be the animal's Home.
Members of an organization who volunteer to help with transporting animals from one place to another, would also be a Foster. And whatever locations are used for transporting to and from should be recorded as Homes with a Foster associated to each one.
People outside of the organization can signup to become a Foster where the system should record their information and create:
- their Foster record
- their Home record
- their Application to become a Foster.
When an Adoption event occurs, the Animal may change Fosters and/or Homes but would no longer have a Need for Adoption.
The system should enable admins to manage the Needs of 1 or more Animals for a Rescue. An Animal may need to move from one Home to another quickly. Multiple animals may need to move from one Home to another by a certain date.
The system should help admins make decisions about what Fosters are available and appropriate (e.g. barring exclusions) for the Animal(s) Needs.
Fosters may have Exclusions that would prevent them from being a Foster. Recording these exclusions could be automatic and/or could be manually assigned by an admin.
Homes may have Exclusions that would prevent them from housing an Animal. Recording these exclusions could be automatic and/or could be manually assigned by an admin.
Different Fosters respond to the needs of an organization differently. Some work well with SMS, others with email, still others work best with phone calls. The system should help admins or Fosters themselves manage this.
The system should provide a way to send a message about Animal Needs to a group of Fosters in the manner most appropriate to the Foster.
Each Foster should have an admin (or other role) primary point of contact with whom the Foster would have a good relationship.
Fosters currently have a boolean admin column. It's likely this should instead become some way of managing a "role".
Records like a Person who is a Foster and Application will likely need a way of tracking status (approved, rejected, etc.).
Multitenancy should be added ASAP. There are currently 2 organizations looking to use this software. Data for one Rescue should not be visible to other Rescues.
All commands in code font are to be copied and pasted onto command line.
git clone https://github.com/rubyforgood/shelter-assist.gitcurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bashnvm install 16.15.1gem install bundler:2.2.27brew install rbenvrbenv install 3.0.2rbenv initrbenv local 3.0.2- Close the CLI tab and open a new one
brew install yarncd path/to/shelter-assistbrew install postgresql(idk, bundle didn't work until I installed this first)bin/setup
Note: a .tool-versions file exists which contains the current supported ruby version
asdf plugin-add rubyasdf install
bin/dev
| Design system | Ant Design |
| Components in Figma File | Ant Design Open Source Figma Library |
| Homepage Illustrations | unDraw illustrations, free for commercial use. |
| Fonts Used | Speech Bubble Text - Sue Ellen Francisco Roboto (Regular, Bold) |
The following is how to setup mailhog, which is a tool to intercept e-mails in a local environment for e-mail testing purposes. The following steps only apply to MacOS users. For non MacOS users, please refer to https://mailtrap.io/blog/mailhog-explained/
- Set up Mailhog using Homebrew. Run the following command in the terminal:
brew install mailhog
- Then start Mailhog in the terminal with:
brew services start mailhog
- After sending an e-mail locally in a test environment, visit the following link:
http://localhost:8025/
- To stop Mailhog use:
brew services stop mailhog
For the hosting environment, you'll need the following environment variables setup to point to your SMTP/Email service.
SHELTERASSIST_HOSTNAME = "https://shelterassist.herokuapp.com
SHELTERASSIST_SMTP_SERVER = "smtp.example.com"
SHELTERASSIST_SMTP_PORT = 587
SHELTERASSIST_SMTP_USER = "myusername"
SHELTERASSIST_SMTP_PASSWORD = "password"
SHELTERASSIST_EMAIL_ADDRESS = "[email protected]"
SHELTERASSIST_EMAIL_ADDRESS is the from address used for outgoing email like password reminders and magic-link emails.