404pandas / PARSR

This is an app to aid in the search and rescue of missing animals

PARSR

Project Animal Reunification Search & Rescue

Brought to you by All Animal Rehabilitation & Release
Explore the docs »

View Demo(Broken) · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project was built with the MERN stack and Apollo + GraphQL. It's currently not deployed until the prototype MVP is completed.

Built With

Getting Started

Once completely built, this application will function as a deployed app on Heroku

Local Installation / Testing

1. Clone the rep

git clone https://github.com/404pandas/PARSR.git

2. Install dependencies

npm run install

3. Seed the database

npm run seed

4. Launch the app in development environments

npm run develop

5. Visit:

localhost

graphQL

Usage

Once the app is functional, screenshots will be added in this section.

Roadmap

MVP

• Front End

  • Routing
  • Map (Markers, Search area)
  • User Auth
  • User Profile Page
  • Landing Page
  • Pet Page
  • Owner Page
  • Map Page
  • Error Page
  • 404 Page
  • Login Form
  • Sign Up Form
  • Test react-ol-wrapper library
  • ? Migrate from ol to react-ol-wrapper ?

• Back End

  • Typedefs
  • Resolvers
  • Seeds
  • User Auth
  • Migrate from MongoDB to Postgres (benefit more from a relational database)

Future Development

• Stripe (Donate Page)
• Chat
• Search

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT license.

See LICENSE.txt for more information.

Contact

Mary Elenius - [e-mail]

in association with:

All Animal Rehabilitation and Release

Project Links:

Figma Board- link later

Github Repository

Deployment- link later

Acknowledgments

I would like to give a big shoutout to my partner in crime and daughter, Yennefer! Every day she proves she is small yet mighty!