https://github.com/burritosoftware/cmpe_milestone1
recipe maker but like yeah
https://github.com/burritosoftware/cmpe_milestone1
Last synced: 6 months ago
JSON representation
recipe maker but like yeah
- Host: GitHub
- URL: https://github.com/burritosoftware/cmpe_milestone1
- Owner: burritosoftware
- Created: 2025-04-09T03:20:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-09T03:25:17.000Z (over 1 year ago)
- Last Synced: 2025-04-14T02:56:07.949Z (over 1 year ago)
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Recipe Maker
Share recipes with ease.
# [Watch Demo Video](https://drive.google.com/file/d/1zhybQ9sJiCyUd6-PuN9R-ICHEClDEfHw/view)
---
Created by the following:
- Zyjay C. ([@burritosoftware](https://github.com/burritosoftware)) - Implemented func reqs 1-5, non func 2
- Stevie C. ([@xethrus-org](https://github.com/xethrus-org)) - Implemented func reqs 6-10, non func 3
- Noah M. ([@N-Menache](https://github.com/N-Menache)) - Implemented func reqs 11-15, non func 1
# Requirements
- [Python 3](https://python.org)
- [Git](https://git-scm.com/)
- [Required libraries in requirements.txt](requirements.txt)
# Setup
1. Make sure you have Python, Git, and pip installed on a Linux system.
2. Clone this repository and switch to it.
```bash
git clone https://github.com/burritosoftware/CMPE_Milestone1.git
cd CMPE_Milestone1
```
3. Create a virtual environment to run the app and initiate it.
```bash
python3 -m venv venv
source venv/bin/activate
```
4. Install dependencies.
```bash
pip3 install -r requirements.txt
```
5. **Hello! If you're grading the project, please do not follow this step and skip to step 6, to preserve the starter database.** Otherwise, if you would like to not use the starter database, which has example recipes and example accounts, delete it.
```bash
rm app/app.db
```
5. Ensure the database is initialized by running these commands.
```bash
flask shell
from app import db
db.create_all()
exit()
```
6. Run the application with the dev server.
```bash
python3 run.py
```
# Usage
You can sign up for an account or log in to an existing account. Logged in users can create new recipes and delete any recipe. Logged out users can only see the recipe list.
An example account and example recipes are included in the starter database `app.db`.
Log in using username and password `stevie`. You can also sign up for a new account.