Steps:
-heat the pay with high heat
-Listening....
-diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4eb7cc6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,50 @@ +# Backend (Python) +be/.env +be/venv/ +be/__pycache__/ +be/*.pyc +be/*.pyo +be/*.pyd +be/.Python +be/env/ +be/pip-log.txt +be/pip-delete-this-directory.txt +be/.pytest_cache/ +be/*.egg-info/ +be/dist/ +be/build/ + +# Frontend +fe/.netlify/ + +# Netlify +.netlify + +# OS generated files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + +# Logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# IDE +.vscode/ +.idea/ +*.swp +*.swo +*~ + +# Environment variables +.env +.env.local +.env.development.local +.env.test.local +.env.production.local diff --git a/README.md b/README.md index 57ced29..2345af6 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,62 @@ Backend: - Google Fit API - OpenAI API +## 🚀Getting Started + +### Prerequisites +- Python 3.7 or higher +- A modern web browser (Chrome, Firefox, Safari, or Edge) +- OpenAI API key + +### Backend Setup + +1. **Clone the repository** + ```bash + git clone https://github.com/YOUR_USERNAME/VeCook-fork.git + cd VeCook-fork/be + ``` + +2. **Install Python dependencies** + ```bash + pip install -r requirements.txt + ``` + +3. **Set up environment variables** + + Create a `.env` file in the `be/` directory with the following: + ``` + OPENAI_API_KEY=your_openai_api_key_here + ``` + +4. **Run the Flask backend** + ```bash + python app.py + ``` + + The backend server will start on `http://localhost:5000` + +### Frontend Setup + +1. **Navigate to the frontend directory** + ```bash + cd ../fe + ``` + +2. **Open with a local server** + + - **Using VS Code Live Server extension:** + Right-click on `index.html` and select "Open with Live Server" + +3. **Access the application** + + Open your browser and navigate to `http://127.0.0.1:5500/fe/` if using Live Server extension. + +### Usage Tips +- 🎥 Allow camera access for hand gesture controls +- 🤚 Raise your hand to activate AI assistance +- 👉 Point right to go to the next step +- 👈 Point left to go back to the previous step + ## 👥Contributors - [**Michelle Chan (@Chelle007)**](https://github.com/Chelle007) — Backend Web Developer - [**Desmond (@desraymondz)**](https://github.com/desraymondz) — JavaScript and ml5.js Developer diff --git a/be/.gitignore b/be/.gitignore deleted file mode 100644 index 50a19c6..0000000 --- a/be/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.env -venv \ No newline at end of file diff --git a/fe/.DS_Store b/fe/.DS_Store new file mode 100644 index 0000000..c328838 Binary files /dev/null and b/fe/.DS_Store differ diff --git a/fe/.gitignore b/fe/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/fe/aichat.html b/fe/aichat.html deleted file mode 100644 index 21c5ab3..0000000 --- a/fe/aichat.html +++ /dev/null @@ -1,41 +0,0 @@ - - -
- - -heat the pay with high heat
-Listening....
-