dlongodev / my-sugr-pet

Insulin shot tracker for your diabetic pet

MySugrPet is an insulin tracking application for pets with diabetes.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

If you have a diabetic pet, you know keeping track of the date, time, dosage and injection location is not an easy task. This tracker is simple but extremely helpful to make sure you are doing the right thing for your pet to stay healthy. This web application comes with an easy to use UI with visuals to make sure you're making the right choice everyday for insulin injection location, personalized with your pet's photo, and useful for when you need to reference your records when visiting your vet.

Screenshots

Original Wireframes

(back to top)

Built With

• Node.js
• Express.js
• MongoDB
• MongooseJS
• <%= EJS %>
• Javascript
• HTML5
• SCSS
• Passport.js
• Bootstrap
• Multer
• Cloudinary

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/dlongodev/my-sugr-pet.git

2. Install NPM packages

   npm install

3. Create .env file

   PORT='3300'
   MONGODB_URI='mongodb://localhost:27017/mysugrpet'
   DB_URL="MongoDB-Database-Link"
   SECRET='thisisasecretthatwillchangelater"
   CLOUDINARY_CLOUD_NAME=put-your-cloudinary-name
   CLOUDINARY_KEY=put-your-cloudinary-key
   CLOUDINARY_SECRET=put-your-cloudinary-secret

4. Run local environment

   npm run dev

(back to top)

Roadmap

MVP / User Stories

• As a user, I can register my information so I can log in when I want to use the tracker
• As a user, I can create a profile for my pet so I can have his information saved for when I need it
• As a user, I can choose my pet to be a dog or cat and the interface will show icons that present my pet
• As a user, I can easily see the buttons I need to press so I can begin tracking my pet insulin injections
• As a user, when I need to choose the injection location, I can easily see the last 4 injections so I can make the right location decision
• As a user, I want to be able to fix the data if I make a mistake
• As a user, I want to be able to delete an entry if I make a mistake
• As a user, I want to be able to make changes to my pet profile

Stretch Goals

• As a user, I want to export the data so I can show it to my vet
• As a user, I want to add my pet photo to his profile
• As a user, I want to keep a record of my pet medical history on its profile, from glucose levels to observational behaviors
• As a user, I want to have a record of vet visits and expenses
• As a user, I want to create reminders for daily insulin shots, food, water, and exercise

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

(back to top)

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

(back to top)

Changelog

Look at CHANGELOG.md for this project.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Daniele Longo - @dlongodev - [email protected]

Project Link: https://github.com/dlongodev/my-sugr-pet

(back to top)

Acknowledgments

• General Assembly 9/28 SEI-Flex
• Billie Heidelberg - SEI Lead
• Matt Keane - Instructional Associate
• Paresh Sharma - Instructional Associate
• Colt Steele - YelpCamp Lessons
• Pet icon by catalyststuff & app design inspiration from pikisuperstar - freepik

(back to top)