https://github.com/rubyforgood/animal-rescue
https://github.com/rubyforgood/animal-rescue
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rubyforgood/animal-rescue
- Owner: rubyforgood
- License: mit
- Created: 2023-09-30T04:00:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-20T02:39:31.000Z (about 2 years ago)
- Last Synced: 2025-05-15T09:55:23.508Z (8 months ago)
- Language: HTML
- Size: 45.8 MB
- Stars: 2
- Watchers: 1
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pet Rescue Adoption Application
The Pet Rescue app is derived from the [Baja Pet Rescue Dog Adoption Application](https://github.com/kasugaijin/baja-pet-rescue/tree/main) 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 link adopters with pets.
---
# 🚀 Getting Started
Let's get your machine setup to startup the application!
## Prerequisites
⚠️ We assume you already have ruby installed with your preferred version manager. This codebase supports [rbenv](
https://github.com/rbenv/rbenv) and [asdf](https://github.com/asdf-vm/asdf-ruby).
## Install & Setup
Clone the codebase
```
git clone git@github.com:rubyforgood/animal-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.
Run the setup script to prepare DB and assets
```sh
bin/setup
```
To run the app locally, use:
```
bin/dev
```
## Accessing Roles
You can use the following login credentials to access the following roles:
Adopter
- email: `adopter1@example.com`
- password: `123456`
Staff
- email: `staff@example.com`
- password: `123456`
You are also able to register an account.
## Subdomain Setup
The app will work OK with no subdomains, but to really test out the multi-tenant capabilities, you will need to configure subdomains. Every `Organization` has a subdomain field, and that Org will be accessible via `ApplicationController#current_tenant`.
To configure your local dev env to test subdomains, you will need to [edit your `/etc/hosts` file](https://linuxize.com/post/how-to-edit-your-hosts-file/)
Add the following line:
This will map the two seed Orgs with the correct subdomains
# 🧪 Running Tests
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
```
# 💅 Linting
We use [standard](https://github.com/standardrb/standard) for linting. It provides a command for auto-fixing errors:
```sh
rails standard:fix
```
# 🔨 Tools
This [google sheets](https://docs.google.com/spreadsheets/d/1kPDeLicDu1IFkjWEXrWpwT36jtvoMVopEBiX-5L-r1A/edit?usp=sharing) contains a list of tools, their purposes, and who has access to grant permissions.
# 📖 About
## Ruby for Good
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
## Pet Rescue Adoption Sites
[Baja Pet Rescue](https://www.bajapetrescue.com)
# 🌟 Core Values
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:
### Code Quality and Collaboration
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.
### Communication and Perspective:
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.
### Engagement and Practicality:
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.
---
# 📚Knowledge Base
## Preparation Work (Before code)
These are just some of the documents put together before writing any code:
* Slide deck to pitch idea to client: [here](https://docs.google.com/presentation/d/1d4gjzADk7BcxmQEVZlesheGUen9d1E3RzrVvskMhVxo/edit?usp=sharing)
* Figma site design: [here](https://www.figma.com/file/x3iM31l8csY7mT0VwKykhT/BPR---Wireframes---Ami?node-id=530186%3A154&t=mgRlseVd2LTKPX4o-1)
* Model association diagram: [here](https://lucid.app/lucidchart/a915c03c-3c09-454d-837b-f3d2768f5722/edit?viewport_loc=-25%2C-973%2C3565%2C2341%2C0_0&invitationId=inv_85cf2967-7b33-4030-903f-9655e767cbbf)