VeggieBot 🌱

VeggieBot is a web application that helps you discover the vegan status of ingredients instantly. It empowers you to make informed choices and lead a cruelty-free and sustainable way of living.

Currently, VeggieBot supports only the input of 5 ingredients.

Features

• Instantly check the vegan status of ingredients;
• User-friendly and accessible interface;
• Light/Dark mode;
• Mobile friendly.

Features backlog

• File Upload (.csv, .txt or others);
• Ingredient scanner through the device camera
• Vegetarian checker

Technologies Used

• Chakra UI: For building the user interface with style and accessibility in mind.
• Next.js: For server-side rendering and creating a fast and efficient web app.
• React: To build the front-end user interface components.
• Open AI GPT-3.5: For generating vegan status of ingredients.

Installation

1. Clone the repository:

git clone https://github.com/MartaBento/veggie-bot.git

2. Navigate to the project directory:

cd veggie-bot

3. Install dependencies:

npm install

4. Set up environment variables:

• Create a new file named .env.local in the project root directory.
• Add the following lines to the .env.local file:

# .env.local

NEXT_PUBLIC_OPENAI_KEY=your-openai-api-key

5. Start the development server:

npm run dev

6. Open your browser and visit http://localhost:3000 to see the application running.

Usage

1. Choose the product to analyse and copy its ingredient list;
2. Paste the ingredient list into the input field and click the Analyze button;
3. Wait for the results to be displayed in the results page.

Contributing

Contributions are welcome! If you find any issues or want to add new features, please open an issue or submit a pull request.

Contact

Connect with me on LinkedIn or GitHub for any questions or discussions related to VeggieBot:

• LinkedIn
• GitHub