Food Copilot is a smart application designed to help users efficiently manage their food items,plan meals according to schedule, and receive personalized recipe suggestions based on their available ingredients.
- Food Item Tracking: Organize your food inventory with details like name, quantity, and calorie content.
- Get Recipes: Personalized recipe suggestions based on available ingredients.
- Meal Planning: Plan meals efficiently around your schedule.
- Time Management: Saves time by helping you prepare meals in advance.
- User-Friendly Design: Simple interface for easy navigation and meal tracking.
- Gemini API: For meal suggestions according to your schedule.
- Spoonacular API: Provides recipe suggestions based on ingredients.
- Next.js (TypeScript): A popular React framework for building server-side rendered applications.
- Firebase Database: For real-time storage and synchronization of food and user data.
- TypeScript: Enhances code scalability and maintainability,ensures type safety.
- Tailwind CSS: Utility-first CSS framework for fast and responsive styling.
Follow these steps to set up and run the project locally -
-
Clone the repository:
git clone https://github.com/SUNIDHI-JAIN125/FoodCopilot.git cd FoodCopilot
-
Install dependencies:
yarn install # or npm install
-
Run the frontend:
yarn dev # or npm run dev
-
Add the following keys in the .env file (Root directory):
NEXT_PUBLIC_GEMINI_KEY = NEXT_PUBLIC_SPOON_KEY =
We welcome contributions to the Food Copilot project! Feel free to report bugs, suggest features, or submit pull requests. Follow these steps to get started:
-
Fork the Repository - Navigate to the Food Copilot Repository, click on the Fork button to create a copy of the repository in your GitHub account.
-
Clone Your Fork - Clone the forked repository to your local machine.
-
Run the project on your local machine, check the Getting Started section to setup the project.
-
Commit your changes with clear commit messages.
-
Push your changes to your forked repository.
-
Create a pull request with your changes and details.
If you find this project helpful or interesting, please consider giving it a star on GitHub!