Giter VIP home page Giter VIP logo

fairest's Introduction

Fair-EST

Description

In a world full of mixed breeds, this application generates estimates for grooming services based on weight and coat type instead of breed which is sometimes hard to determine.

Technologies

The programs backend was written in Python and the Django ORM was used as a templating engine for creating models that interface with the SQL Database and to manipulate the DOM and display database information.

Python was chosen due to its ease of use and it's forgiving syntax. Django ORM on the other hand, interfaces extremely well with the database and therefore relationships between database entries are easily defined.

A SQL database was utilized because of the nature of the relationships needed between the database models of this project. For example (in this situation): grooming shops have multiple customers, customers have multiple dogs, dogs have only one owner. Using a relational database was important to effectivley and efficiently map these connetions.

Screenshots

alt text alt text

Installation

  1. Clone the repository down to your local drive by opening up a terminal in the folder of your choice and type the code:
git clone https://github.com/KISMET-INC/FairEst.git
  1. Download and Install Python 3.6.4 onto your machine.

  2. Be sure to Add Python 3.6 to PATH but checking the box at the bottom of the screen

    • Add Python 3.6 to PATH
  3. Create a virtual environment for the project.

Windows:
python -m venv py3Env

Mac/Linux
python3 -m venv py3Env
  1. Activate the environment
Mac/Linux: 
source py3Env/bin/activate                         
 
Windows command prompt : 
call py3Env\Scripts\activate       

Windows git bash :
source py3Env/Scripts/activate         
  1. With your virtual environment active install Django using PIP package manager
Windows/Mac: 
$ pip install Django==2.2.4 

Note: If PIP isn't installing you may hae to add it to your PATH

  1. Now you should be able to work with and edit the file.

  2. To run the project navigate to the folder where you cloned this repo and run this in the command line

python manage.py runserver

Support

Any questions or comments about this repository and it's contents can be emailed to [email protected].

Roadmap

In future updates I plan to:

  • add more services to the estimates like desheds and special shampoos
  • a login and registration for business owners to access their individual clients and estimates
  • A feature that allows the estimates to be printed and/or emailed to the client

Contributing

I am not accepting contributions to this project at this time.

Authors and Acknowledgment

Thank you to the amazing staff and instructors at Coding Dojo for teaching me the skills and technologies needed for me to complete this project.

fairest's People

Contributors

kismet-inc avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.