pete-hall / kanine-plus

A DRM (Dog Relationship Managment) system to organize and streamline dog walking operations.

View Demo (in progress) · Report Bug · Request Feature

Table of Contents

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

About The Project

Duration: 2 week sprint for MVP

I work as a professional part time walker for a small business based out of south Minneapolis. They manage all of their dog specific data manually (i.e. spreadsheets). I wanted to design what could be used as an internal tool for them to manage all of their dog specific data in order to streamline their operations.

Feature overview:

• User authentication and authorization
• Users can add new dogs to the system, edit that information, read it, and delete dog's entirely from the system all in a modern interface
• Users can upload a image of a dog and add notes for a specific dog

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• React.js
• Redux
• Redx-Saga
• React-Router
• Material UI
• Node.js
• Express.js
• PostgreSQL
• Multer
• Cloudinary

(back to top)

Getting Started

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

Prerequisites

(Node.js is used in this project)

Installation

1. Get a free API Key at https://cloudinary.com/
2. Clone the repo

   git clone https://github.com/Pete-Hall/kanine-plus

3. Install the NPM packages used in this project

   npm install

4. Create a .env file and enter your API information

   CLOUD_NAME = 'ENTER YOUR CLOUD_NAME HERE'
   API_KEY = 'ENTER YOUR API_KEY HERE'
   API_SECRET = 'ENTER YOUR API_SECRET HERE'

5. Create a database in named 'kanine_plus'. The project is built on Postgres, so you will need to make sure to have that installed. Using Postico is recommended to run queries as that was used to create the queries
6. The queries in the database.sql file are set up to create all the necessary tables and populate those tables with the data to allow the application to run correctly. Execute the queries in that file top to bottom
7. Run npm run server in your terminal to start up the server
8. Run npm run client in your terminal to start up the client in your browser
9. The npm run client command will open up a new browser tab for you! (if not there will be a localhost link in your terminal you can use)

(back to top)

Roadmap

• Deploy on Heroku
• JEST/unit testing
• Add Google Maps to add addresses and view where each dog lives on a map
• Add a dynamic scheduler that generates the current week's schedule based on any previous ad-hoc changes
• Add a 'walker' user role that can read all data and only create/delete notes for the dogs only in the system for the company they work for (authorization)
• Add an admin settings component to allow the admin to control user permissions and certain features
• Refactor code to re-use components
• Refactor code to use formData to set state (as opposed to many hooks)
• Refactor upload image to all happen with onChange
• Add ability to delete an image when hovering over it in the edit mode

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

(back to top)

License

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

(back to top)

Contact

Pete Hall - [email protected]

Project Link: https://github.com/Pete-Hall/kanine-plus

(back to top)

Helpful

• The Best README Template from othneildrew
• Figma for wireframing
• DB Designer for database ERD's
• npm multer-storage-cloudinary for resouces to upload an image
• Material UI docs

Acknowledgments

I want to thank Prime Digital Academy and Dev for this amazing experience. My cohort for being the greatest of all time, my friends for understanding why I disappeared for the last 5 months, and my partner and family for making this possible.

(back to top)