Project Setup Guide

This project requires running 5 separate services simultaneously. Follow the instructions below to set up and run the complete application.

Prerequisites

• Node.js and npm
• Python 3.x
• Required environment variables (.env files for each service)

Installation & Running Instructions

You'll need 5 terminal windows to run all services. Follow these steps in order:

Terminal 1: Main Server

cd server
npm install
npm start

Terminal 2: Client

cd client
npm install
npm run dev

Terminal 3: Chatbot Backend

cd Backend/chatbot

Common Setup Steps (for all Python services):

python -m venv venv
./venv/scripts/activate  # On Windows
# source venv/bin/activate  # On Mac/Linux
pip install -r requirements.txt

Run the service:

uvicorn app:app --reload

Terminal 4: AI Server

cd Backend/AI_Server

Follow the Common Setup Steps mentioned above, then:

python app.py

Terminal 5: Edit Server

cd Backend/AI_Server/Edit_Server

Follow the Common Setup Steps mentioned above, then:

python ai_edit.py

Important: Fixing psycopg Installation Issues

When installing dependencies for Terminal 4 and Terminal 5, you may encounter errors with psycopg. To fix this:

# Uninstall all psycopg variants
pip uninstall psycopg psycopg2 psycopg2-binary psycopg3 -y

# Install the binary version
pip install psycopg2-binary

This issue typically occurs during the pip install -r requirements.txt step. Apply this fix in both the AI Server and Edit Server environments.

Environment Configuration

Make sure to create appropriate .env files for each service with the required environment variables before running the services.

Service Architecture

1. Server - Main backend server
2. Client - Frontend application
3. Chatbot - Chatbot backend service
4. AI Server - CP + Heuristic AI service
5. Edit Server - Agentic AI editing service

Troubleshooting

• Ensure all services are running on different ports to avoid conflicts
• Check that all .env files are properly configured
• Verify Python virtual environments are activated before installing dependencies
• If you encounter port conflicts, check and modify port configurations in respective service files

Notes

• Keep all 5 terminals running simultaneously for the application to function properly
• Services may take a moment to start up; check terminal output for success messages
• Some services use --reload flag for auto-reloading during development