https://github.com/aspects19/pantry-pal

https://github.com/aspects19/pantry-pal

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/aspects19/pantry-pal
• Owner: aspects19
• License: gpl-3.0
• Created: 2025-03-11T12:23:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-12T12:13:55.000Z (over 1 year ago)
• Last Synced: 2025-03-12T12:31:06.210Z (over 1 year ago)
• Language: JavaScript
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# PantryPal | A hackathon project

PantryPal is a WhatsApp bot that uses Gemini API to suggest a recipe off a list of ingredients you give to it. It has the ability of suggesting additional recipies if you give too few engredients. This is a project for this [Hackathon](https://build-your-own-ai-chat-bot.devpost.com)

![JavaScript](https://img.shields.io/badge/JavaScript-vES15-yellow?style=flat&logo=javascript&logoColor=white)

![Baileys/WhiskeySockets](https://img.shields.io/badge/Baileys%2FWhiskeySockets-v6.7.16-green?style=flat&logo=whatsapp&logoColor=white)

![Generative-ai](https://img.shields.io/badge/Gemini-v0.24.0-orange?style=flat&logo=google-gemini&logoColor=white)

## Installation

To run the PantryPal locally, follow these steps:

1. Clone the repository:

   ```sh

   git clone https://github.com/aspects19/pantry-pal.git

   ```

2. Navigate into the project directory:

   ```sh

   cd pantry-pal

   ```

3. Install dependencies

    ```sh

    npm install

    ```

4. Create a ` .env ` file in the root of the project and add ` GEMINIAI_API="gemini-api-key" ` with your gemini API.

5. Start app

   ```sh

   npm start

   ```

5. Scan the **QR code** that will be displayed on your terminal.

6. 🥳 Your bot is up and working.

## License

This project is licensed under the MIT License – see the [LICENSE](https://github.com/aspects19/pantry-pal/blob/main/LICENSE) file for details.

##

Thanks for checking out PantryPal.