BiteClub

Welcome to the BiteClub project repository!
This repo contains two main applications:

• BiteClub: Our Next.js web application for restaurant reviews, user profiles, blog posts, and more.
• Recommender System: A Python-based microservice for personalized recommendations.

Project Structure

• biteclub/
  The main web application built with Next.js.
  See biteclub/README.md for setup, development, and deployment instructions.

• recommender-system/
  The recommendation engine (Python, Flask).
  See recommender-system/readme.md for installation and deployment details.

Quick Start

1. Clone the repository and go to the project directory

2. Set up environment variables:

   • For BiteClub, copy biteclub/.env.example to .env or .env.local and fill in required values.
   • For Recommender System, see its README for .env details.

3. Install dependencies:

   • For BiteClub:
     See biteclub/README.md
   • For Recommender System:
     See recommender-system/readme.md

Deployment

• BiteClub can be deployed on Vercel or any Node.js hosting platform.
• Recommender System can be deployed using Docker or on Heroku.

Refer to the README files listed below for step-by-step deployment instructions:

• BiteClub Setup & Usage
• Recommender System Setup & Usage

Documentation & Reports

• Software Requirements Specification (SRS):
  See documents/SRS.pdf for the original project requirements.
• Database Models Report:
  See documents/DatabaseModelsReport/index.html for a visual overview of the database schema and relationships. Download the full documents/DatabaseModelsReport/ folder to ensure all assets and scripts are available for proper rendering.
• Test Credentials & Deviations:
  See documents/README.md for test account credentials and a list of deviations from the SRS.