Skip to content

Commit d6402b5

Browse files
authored
Updated Dependencies, How to Run, Application Access
1 parent 8061948 commit d6402b5

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,40 @@ Create a recipe based on ONLY the ingredients inside your fridge! Skip the store
66

77
This Flask application generates recipes in JSON format using OpenAI's GPT-3.5.
88

9-
### Prerequisites
9+
#### Prerequisites
1010

11-
- Python 3.6 or higher
12-
- pip
11+
- Python 3.7 or higher (Make sure Python is [added to your system's PATH](https://www.youtube.com/watch?v=iNoQeRj52zo&ab_channel=ChartExplorers))
1312

14-
### Installation
13+
- [pip](https://www.youtube.com/watch?v=fJKdIf11GcI&ab_channel=TheCodeCity)
14+
15+
## Installation
1516

1617
First, clone the repository to your local machine:
1718

18-
```bash
19+
```
1920
git clone https://github.com/acageduser/cook-ai.git
2021
cd cook-ai
2122
```
2223

23-
## Windows
24-
25-
```bash
26-
python -m venv venv
27-
venv\Scripts\activate
28-
```
24+
## Running the Application
2925

30-
## macOS and Linux
26+
#### Windows
27+
To start the application on Windows, run the provided batch file:
3128

32-
```bash
33-
python3 -m venv venv
34-
source venv/bin/activate
3529
```
36-
37-
## Install the required dependencies
38-
```bash
39-
pip install -r requirements.txt
30+
start_local-windows.bat
4031
```
4132

42-
## Running the Application
33+
#### macOS and Linux
34+
To start the application on macOS or Linux, run the provided shell script:
4335

44-
```bash
45-
flask run
4636
```
37+
./start_local-macos-linux.sh
38+
```
39+
40+
## Accessing the Application
41+
Open ```start_local-windows.bat``` (Windows) or ```start_local-mac.sh``` (mac/Linux). This is the local server. Once the local server is running, open your web browser and navigate to:
4742

48-
This will start the Flask server on http://127.0.0.1:5000. Navigate to this address in your web browser to interact with the application.
43+
[```http://127.0.0.1:5000```](http://127.0.0.1:5000)
44+
This will bring up the CookAI interface where you can generate recipes based on the ingredients you have.
4945

0 commit comments

Comments
 (0)