Created for: CS3200 Database Design Final Project
Table of Contents
Automatically generate your shopping list for a selected number of recipes. Import or manually add recipes to a locally stored database.
Clone and navigate into the repository:
git clone git@github.com:montymi/LazyGrocer && cd LazyGrocerOn Unix Systems:
chmod +x ./start.sh
./start.sh -iOn Windows:
./start.shOnce the application is started in interactive mode, a container will startup, connect to the local mysql volume and prompt you with ID navigation through this menu:
Select Service:
1. Create
2. Read
3. Update
4. Delete
5. Quit
Service ID: _
LazyGrocer/
├── .github/
│ └── workflows/
│ └── python-app.yml
├── scripts/
│ └── init.sql
├── src/
│ ├── controller/
│ │ ├── dataControllerv2.py
│ │ └── __init__.py
│ ├── model/
│ │ ├── enums/
│ │ │ ├── scripts.py
│ │ │ ├── tables.py
│ │ │ └── __init__.py
│ │ └── __init__.py
│ ├── testing/
│ │ ├── test_data_inserts.py
│ │ ├── test_data_selects.py
│ │ └── __init__.py
│ ├── main.py
│ ├── requirements.txt
│ └── __init__.py
├── docker-compose.yml
├── Dockerfile
├── start.sh
├── README.md
└── LICENSE.txt
- add exporting recipes as JSON
- add installation instructions
- add Structure section
- add Sanay and Colby information in Contact section
- containerize for reproducibility
- add passive start in detached mode
- add APIs with FastAPI
- add CLI support when started in detached mode
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
Distributed under the GPL License. See LICENSE.txt for more information.
Michael Montanaro
Colby Hegarty
Sanay Doshi