Petential

About | Demo | Quick Start | Tech Stack | Team Petential

About

Petential is a web application that allows you and members of your family to keep track of your pet's daily needs.

• Create a pack for your pet
• Share you unique 6 letter code with your family, allowing them to join the pack
• No need to remember your code, your browser will remember you until you log out
• Track meals and treats
• Record walks and check your local weather to help plan your walks

Demo

Quick Start

1. Clone this repo
2. Ensure you have python 3.9 downloaded on your system
3. Run source venv/bin/activate to set up the virtual environment
4. cd pet_tential to move into the project repo
5. Generate a Django secret key and save it in petential_extension/pet_tential/pet_tential/secret_key.txt
6. Run pip3 install -r requirements.txt to install the dependencies
7. Run python3 manage.py makemigrations & python3 manage.py migrateto create your database
8. Run python3 manage.py runserver to run the server
9. Install Node.js
10. cd frontend and run npm i to install node modules
11. Run npm run dev to start the front end server
12. Navigate to localhost or if your console specifies another port, navigate to that instead of 8000

Run Tests

1. cd pet_tential to move into the project repo.
2. Run python3 manage.py test -v 2 to run tests.
3. To see test coverage, run coverage run --omit='*/venv/*' manage.py test and then coverage html.
4. cd htmlcov and then open index.html to see a snapshot of the test coverage (99% coverage backend).

Tech Stack

Use	Backend	Frontend
Framework	Django	ReactJS
Language	Python	Javascript
Package Manager	pip	npm
Testing	Unittest	Jest
Database	PostgreSQL
Styling		Material UI

Planning

We used the github wiki to plan the project and track our progress:

• We made User Stories to drive our features.
• Entity Relationship Diagrams helped plan out database structure.
• Mockups were made using Balsamiq.
• We protected our main branch and required two approvals before merging pull requests.
• There were lots of great resources that helped us along the way.

Team Petential

Petential was made as a 2 week final project for Makers by:

Mel | Lucy | Savanna | Georgie

Extension work was undertaken by Mel, Lucy & Georgie.