CaseBud Codebase

Welcome to the CaseBud codebase! This repository contains the source code for the CaseBud project, including the frontend, backend, model, and landing page applications.

Live Demo

Table of Contents

• Prerequisites
• Environment Setup
• Backend Setup
• Model Setup
• Frontend Setup
• Landing Page Setup
• Running the Applications
• API Documentation

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Node.js (v14 or higher)
• npm (v6 or higher)
• Python (v3.8 or higher)
• pip (v20 or higher)
• MongoDB (v4.4 or higher)

Environment Setup

1. Clone the repository:

   git clone https://github.com/CaseBud/codebase.git
   cd codebase

2. Copy the example environment files and update them with your configuration:

   cp backend/.env.example backend/.env
   cp model/.env.example model/.env

Backend Setup

1. Navigate to the backend directory:

   cd backend

2. Install the required npm packages:

   npm install

3. Start the backend server:

   npm run dev

Model Setup

1. Navigate to the model directory:

   cd model

2. Install the required Python packages:

   pip install -r requirements.txt

3. Start the model server:

   uvicorn main:app --reload

Frontend Setup

1. Navigate to the frontend directory:

   cd frontend

2. Install the required npm packages:

   npm install

3. Start the frontend development server:

   npm run dev

Landing Page Setup

1. Navigate to the landing page directory:

   cd landing-page

2. Install the required npm packages:

   npm install

3. Start the landing page development server:

   npm run dev

Running the Applications

To run the applications, ensure that the backend, model, frontend, and landing page servers are all running simultaneously. You can access the applications via the following URLs:

• Backend API: http://localhost:3000
• Model API: http://localhost:8000
• Frontend: http://localhost:3001
• Landing Page: http://localhost:3002

API Documentation

The backend API documentation is available at http://localhost:3000/api-docs once the backend server is running.