The Pet Rescue app is derived from the Baja Pet Rescue Dog Adoption Application created by @kasugaijin who wanted to give back to the grassroots organization from where he adopted his dog in Mexico by building them a web application. Pet Rescue is an application that makes it easy to connect shelters with people who are looking to adopt or foster pets.
Let's get your machine setup to start up the application!
Install a containerization app, such as Docker Desktop.
Clone the repo to your local machine and navigate to the directory and run:
docker-compose build to build the base image.
docker-compose up to start the containers. You can add the -d flag to run silently without logging.
docker-compose run --rm app bin/setup to set up and seed the database.
If you need to run migrations at all: docker-compose run --rm app bin/rails db:migrate
Visit localhost:3000 in your browser.
Installing PostgreSQL is required to run the application.
Instructions: https://wiki.postgresql.org/wiki/Homebrew
brew install postgresqlTo run postgresql as a service:
brew services start postgresqlA docker-compose.yml is provided that will run postgres inside a local docker container without requiring a full OS install.
Before bringing the image up, you'll need to choose a database username and password by exporting the following environment variables.
Using direnv is recommended here, to manage environment variables locally.
export DATABASE_USERNAME=[your username]
export DATABASE_PASSWORD=[a password]
Once your environment has been set, you may launch the postgres database, and any other dependencies, by running docker compose up -d
Clone the codebase
git clone git@github.com:rubyforgood/pet-rescue.git
Create a new config/application.yml file from the config/application.example.yml:
cp config/application.example.yml config/application.yml
Update your config/application.yml by replacing the places that say REPLACE_ME. If you installed and configured PostgreSQL as discussed above
you can use your username and leave the password blank for development.
Run the setup script to prepare DB and assets
bin/setupTo run the app locally, use:
bin/dev
You should see the seed organization by going to:
http://localhost:3000/alta/
All users are scoped to an organization. Hence, you must login via the correct login portal per organization.
You can use the following login credentials to login to http://localhost:3000/alta:
Use the following login Adopter
- email:
adopter1@alta.com - password:
123456
Staff
- email:
staff@alta.com - password:
123456
Run unit tests only
./bin/rails test
Run system tests only (Headless)
./bin/rails test:system
Run system tests only (Not-Headless)
CI=false ./bin/rails test:system
Note: If system tests are failing for you, try prepending the command with APP_HOST=localhost. Your host might be misconfigured.
APP_HOST=localhost ./bin/rails test:system
Run ALL tests:
./bin/rails test:all
We use standard for linting. It provides a command for auto-fixing errors:
rails standard:fixIf you find yourself writing a conditional checking the question, "Is the user allowed to view/do this?" that is an authorization concern. Pet Rescue utilizes the gem Action Policy as our authorization framework. If you are familiar with Pundit, you will see many similarities. If you want to learn more about authorization or have questions about how Action Policy works, their documentation is excellent. If you would like a quick onboarding to how Action Policy is used in Pet Rescue, see our wiki page on authorization.
This google sheets contains a list of tools, their purposes, and who has access to grant permissions.
Please feel free to contribute! Priority will be given to pull requests that address outstanding issues and have appropriate test coverage. Focus on issues tagged with the next milestone for higher priority.
To contribute:
-
Identify an unassigned issue
-
Only work on one issue at a time
-
Request assignment of an issue by adding a comment on the issue
-
Fork the repo if you're not yet a contributor
-
Ensure that the application runs locally in your browser. When you run the test suite locally, it should pass
-
Create a new branch for the issue using the format
XXX-brief-description-of-feature, whereXXXis the issue number -
Make code changes related to the assigned issue
-
Commit locally using descriptive messages that indicate the affected parts of the application
-
Add tests related to your work(most of the time)
-
Ensure all tests pass successfully; if any fail, fix the issues causing the failures
-
Make a final commit if any code changes are required
-
Push up the branch
-
Create a pull request and fill out the description fields
-
We like to make sure people are recognized for their contributions, so please attribute others by commenting on a pull request with
@all-contributors please add @<username> for <contributions>. please add @<username> for <contributions>.Replace
<contributions>withcodeorreview
Pet Rescue is one of many projects initiated and run by Ruby for Good. You can find out more about Ruby for Good at https://rubyforgood.org
While vision is the destination, and strategy is how we'll get there, core values are what we'll use to handle times of change or uncertainty (both of which are expected, guaranteed to happen, and positive signs of growth!).
We are committed to promoting positive culture and outcomes for all, from coders and maintainers and leads to pet rescue and adoption administrators -- and animals everywhere.
We will lean on the following as guiding principles when interacting with others -- stakeholders, as well as current and future maintainers, leads, and collaborators -- and we ask that anyone engaging with this project in any capacity to do the same. Know that we do want to know how and when (not if) we can improve upon these values and/or the way in which we live by and act in accordance with them, so please comment here and in PRs when you have ideas.
Here are our core values defined by early contributors and leads:
Write maintainable code that is accessible and enjoyable (for beginners and seasoned coders alike), supports and encourages contributors and their contributions, and ensures long-term sustainability of this project and the efforts it supports.
Prioritize clear communication, embrace diverse viewpoints, and always engage feedback -- all with a commitment to timely responses and ongoing improvement for all. Rescue and adoption partner perspectives will be prioritized over abstracted conceptualization of their needs.
Build upon stakeholder partnerships to foster and encourage their active involvement, focusing constructive discussion and dispute resolution on the practical impact of our collective work.
These are some resources that may help with contributing to the codebase
- Figma site design
- Model association diagram: Import the schema.rb file into https://dbdiagram.io/d to get the latest version of the diagram
- Turbo Rails Tutorial
- Geek UI Documentation
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!