Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 2.25 KB

README.md

File metadata and controls

65 lines (51 loc) · 2.25 KB

logo

RecipeRover is an intuitive platform designed for recipe management and discovery, built as part of a Final year Project. This repository houses the production-ready codebase for the project. You can view the live version of the website here: RecipeRover

🌟 Features

Recipe Discovery: Find recipes based on your preferences and available ingredients.

  • User-Friendly Interface: Intuitive and responsive design.
  • Customizable Search Filters: Search recipes by ingredients, preparation time, or cuisine type.
  • Ingredient Management: Easily manage and add your ingredient inventory.

🚀 Technologies Used

  • Frontend: Next.js (with Tailwind CSS)
  • Backend: Python
  • Database: MongoDB
  • Deployment: Vercel for frontend and Hugging Face for backend
  • Others: TypeScript, React.js

📂 Project Structure

  • backend/     # Backend API and server logic
  • components/ui/    # UI components for the frontend
  • public/    # Static assets
  • src/    # Application source files
  • .eslintrc.json    # ESLint configuration
  • tailwind.config.ts    # Tailwind CSS configuration
  • package.json    # Node.js dependencies

⬇️ Installation Steps

1. Clone the repository:

2. Install frontend dependencies:

  • cd src
  • npm install

3. Configure the backend:

  • cd backend
  • pip install -r requirements.txt

4. Run the backend server:

  • uvicorn main:app --reload

5. Start the frontend:

  • cd src
  • npm run dev

6. Open your browser and navigate to:

🌐 Deployment

1. Frontend:

  • Deployed using Vercel.
  • Update the vercel.json configuration file as needed.

2. Backend:

  • Log in to your Hugging Face account.
  • Create a new Space for your backend.
  • Upload your backend files to the Space, or connect it to this GitHub repository.

🧑‍💻 Contributors

⭐ Thanks, Have a great day ⭐