Created for: CS3200 Database Design Final Project
By: Michael Montanaro, Colby Hegarty, Sanay Doshi
Table of Contents
Automatically generate your shopping list for a selected number of recipes.Import or manually add recipes to a locally stored database.
On Unix Systems:
$ python --version && python3 --version
# TODO: add installation instructions
$ lg --version// Start app for UI
lg
// Use CLI tools
lg recipe // return list of recipes
lg ingredient // return list of ingredients
lg write [ *file* ] // create a recipe
lg url *link* // create recipe from valid link${LAZYGROCER_ROOT}
├── lazyGrocer.py
├── docs
| ├── plantum1
| | ├── class.wsd
| | └── erd.wsd
│ ├── diagrams
| | ├── class/LazyGrocerClassDiagram.png
| | └── erd/LazyGrocerERDdiagram.png
├── services
| ├── TODO
| └── TODO
├── artifcats
| ├── data
| | └── test.db
| ├── exports
| | └── example.json
├── README.md
├── __init__.py
├── .gitignore
└── LICENSE.txt
- add exporting recipes as JSON
- add installation instructions
- add Structure section
- add Sanay and Colby information in Contact section
See the open issues for a full list of issues and proposed features.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Documentation must include a license section in which the type of license and a link or reference to the full license in the repository is given.
Distributed under the MIT License. See LICENSE.txt for more information.
Michael Montanaro - LinkedIn - [email protected]
Project Link: https://github.com/montymi/LazyGrocer