You can find the deployed project at Pawsnfind.com.
Animal Rescue organizations have so much to manage, but their biggest concern is making sure pets go to a great home. Pawsnfind allows rescues to manage their operations while making it easier for adopters to find their perfect pet and connect with the rescue.
| Ming Liu | Christopher Riffle | Sarah Lee | James Pak | Aruna Benjamin | Hung Pham | Lenna Mau |
|---|---|---|---|---|---|---|
 |
|
|
|
|
|
|
- Sign up and onboarding
- View summary of operations including total animals, donations, and total applications
- Add and edit rescue contacts and locations
- Add, edit, view animals for animal locator site
- Internal notes for each animal
- View, update status and internal notes for applications received
- Visitors can search for pets based on zip code radius and animal type
- Results page gives visitors an option to narrow their search by breed, size, gender, coat length and age of animal
- Detailed animal page shows more info about each animal and allows vistors to complete an adoption application, donate, and follow the animal
- Detailed page about each rescue organization with contact info and list of their animals
- React
- React Router
- Redux
- Material UI
@material-ui/core: 4.1.0,
@material-ui/icons: 4.1.0,
auth0: 2.18.0,
auth0-js: 9.11.2,
axios: 0.18.0,
bootstrap: 4.3.1,
chartist: 0.10.1,
classnames: 2.2.6,
dotenv: 8.0.0,
history: 4.9.0,
jwt-decode: 2.2.0,
logger: 0.0.1,
material-ui-dropzone: 2.4.0,
moment: 2.24.0,
node-sass: 4.12.0,
nouislider: 13.1.5,
perfect-scrollbar: 1.4.0,
react: 16.8.6,
react-big-calendar: 0.21.0,
react-bootstrap-sweetalert: 4.4.1,
react-chartist: 0.13.3,
react-datetime: 2.16.3,
react-dom:16.8.6,
react-google-maps: 9.4.5,
react-input-mask: 2.0.4,
react-jss: 8.6.1,
react-jvectormap: 0.0.12,
react-redux: 7.0.3,
react-router-dom: 5.0.1,
react-scripts: 3.0.1,
react-swipeable-views: 0.13.3,
react-table: 6.10.0,
react-tagsinput: 3.19.0,
react-text-mask: 5.4.3,
reactstrap: 8.0.0,
redux: 4.0.1,
redux-logger: 3.0.6,
redux-thunk: 2.3.0
Front end deployed to Netlify Pawsnfind.com
Back end built using:
- NodeJS
- Express
- PostgreSQL
- Knex
A service that provides authentication which allows users to securely register and login using multiple identity providers. Analytics are also provided by Auth0. Pawsnfind uses AuthO for registration with either email or google and to login into both rescue and user accounts.
Provides a way to securely accept payments. Pawsnfind uses a feature in the Stripe API called connect. It allows Pawsnfind as a platform to transfer donations directly from adopters to rescue organizations.
Propublica Nonprofit Explorer API provides a way to verify EIN numbers are valid and non profit organizations. Pawsnfind uses it in the rescue on boarding process to validate the EIN number entered by the organization rep.
SendGrid API allows Pawsnfind to receive emails from the contact us form and to send a notification to the rescue organization when an application is received.
This module allows Pawsnfind to conduct a radius search for a zip code that is input by a visitor.
This displays pictures of animals in a responsive carousel.
In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:
* REACT_APP_AUTH0_CALLBACK_URL - for development using a local server
* REACT_APP_AUTH0_CLIENT_ID - provided in the Auth0 dashboard
* REACT_APP_AUTH0_DOMAIN - provided in the Auth0 dashboard
* REACT_APP_AUTH0_LOGOUT_DOMAIN - provided in the Auth0 dashboard
* REACT_APP_AUTH0_LOGOUT_URL - optional for your local development server
* REACT_APP_BACKEND_URL - optional for your local development server
* stripe_pk - provide by stripe
* REACT_APP_clientid - this is the Stripe_connect clientID, generated in Stripe_connect settings
| Name | Source / Creator | License |
|---|---|---|
| Material Dashboard Pro React | Creative Tim | Developer |
| Icons | Freepik | flaticon.com |
The following are used for testing:
- testing-library/react
- Jest
- react test renderer
#Installation Instructions
Clone this repo and use the following commands to get started
* npm install - installs dependencies locally
* npm start - starts the production server after a build is created
* build - creates a build of the application
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.