Brevity

LLM Content Summarizer

Local Setup

Frontend

1. Navigate to the Frontend Directory

   cd frontend

2. Install Dependencies

   npm install

3. Start the Development Server

   npm start

4. Access the App Open your browser and go to http://localhost:3000

Backend

1. Navigate to the Backend Directory

   cd backend

2. Create a Virtual Environment

   python3 -m venv env

3. Activate the Virtual Environment

   • On macOS/Linux:

     source env/bin/activate

   • On Windows:

     .\env\Scripts\activate

4. Install Dependencies

   pip install -r requirements.txt

5. Set Up Environment Variables

   • Create a .env file in the backend directory.
   • Add your OpenRouter API key:

     OPENROUTER_API_KEY=your_api_key_here
     

6. Start the Backend Server

   uvicorn server:app --reload

7. Access the Backend The server runs at http://localhost:8000

Convex

1. Install Convex CLI

   npm install -g convex

2. Log In to Convex

   convex login

3. Navigate to the Convex Directory

   cd convex

4. Deploy the Schema

   convex deploy

5. Start the Convex Dev Server

   convex dev

6. Access Convex The Convex functions are now ready to use.

Running the Full Application

1. Start All Services

   • Ensure the backend server and Convex dev server are running.
   • Start the frontend as described above.

2. Use the Application

   Open your browser and go to http://localhost:3000 to start using Brevity.