Setup Instructions

Prerequisites

Before you begin, ensure you have the following installed:

• Python 3.8 or higher
• Node.js 16.0 or higher
• npm or yarn package manager

Installation

1. Clone the Repository

git clone <repository-url>
cd <project-directory>

2. Backend Setup

Navigate to the backend directory and install Python dependencies:

cd backend
pip install -r requirements.txt

3. Frontend Setup

Navigate to the frontend directory and install Node.js dependencies:

cd frontend
npm install
# or if using yarn
yarn install

Configuration

API Key Setup

1. Open main.py in your preferred text editor
2. Locate the API key configuration section
3. Replace the placeholder with your actual API key:

API_KEY = "your-api-key-here"

Email Authentication

Configure email authentication by updating the following fields in main.py:

EMAIL_CONFIG = {
    "email": "your-email@example.com",
    "password": "your-email-password",
    "smtp_server": "smtp.gmail.com",  # Update if using different provider
    "smtp_port": 587
}

Note: For Gmail users, you'll need to generate an app-specific password rather than using your regular password. Visit Google App Passwords to create one.

Running the Application

Start the Backend Server

cd backend
python main.py

The backend server will start on http://localhost:8000

Start the Frontend Development Server

In a new terminal window:

cd frontend
npm start
# or if using yarn
yarn start

The frontend application will open in your browser at http://localhost:3000

Troubleshooting

• API Key Issues: Ensure your API key is valid and has the necessary permissions
• Email Authentication Errors: Check that you're using an app-specific password if required by your email provider
• Port Conflicts: If ports 8000 or 3000 are in use, you can modify them in the respective configuration files

Security Notes

• Never commit your API keys or email credentials to version control
• Consider using environment variables for sensitive configuration
• Create a .env file for local development (remember to add it to .gitignore)