Skip to content

ssan2507833/mvp-pet-app

Repository files navigation

MVP - My Valuable Pet

Description

This application has been designed by team-express for coding bootcamp at the University of Birmingham. This full-stack application has been designed with pet owners in mind, giving the user the ability to keep track of all their pets needs and data.

Table of Contents

Section About that section
Description More information about the application & the thoughts behind it
User Story How we expect the user to interact with our application
Installation Instructions on how to install the application
Usage Find out how you can start using the application
Testing Test for JavaScript
Contributing Find out how you can contribute to the application if you have any improvements or bug fixes
Deployed Link Live Heroku link
Screenshots See a preview of what the application can do
Licence Find out what licence we are using
Future Development See the future plans for this application
Contact Us Contact the team behind the application

User-Story

* As a user, I want to be able to create an account

* As a user, I want to be able to add, edit & remove pets & their relative information.

* As a user, I want to be able to view a gallery of all pets submitted by all users.

Installation

- Run npm install
- Create a `.env` file and add your connection credentials
- Run database schema if this is your first time running this.

Usage

- Run 'npm run start'

Testing

- Run 'npm run test'

Contributing

If you would like to contribute on this project at all, please contact anyone of us via email or phone. All personal details are in our 'about us' page.

Deployed-Links

- Heroku Link: https://mvp-pet-app.herokuapp.com

Screenshots

UI-before-login UI-after-login

Licence

MIT Licence

Future-Development

  • Send reminders or notifications via text or email
  • Share pets info with other users (i.e a partner)
  • Allow users to share photos on gallery page
  • Add space for i) pet adoption organizations ii) potential advertising to make the application profitable

Contact-Us

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published