Installation

Install Beep.AI.Researcher on your system

Prerequisites

  • Python 3.10+ -- The application is built on Flask
  • SQLite or PostgreSQL -- SQLite is used by default for development
  • Beep.AI.Server (optional but recommended) -- For AI features like RAG chat, code suggestions, and extraction
  • Web browser -- Chrome, Firefox, Safari, or Edge

Step-by-Step Installation

  1. Clone the repository and navigate to the project directory
  2. Create a virtual environment: python -m venv venv
  3. Activate the virtual environment:
    Linux/Mac: source venv/bin/activate
    Windows: venv\Scripts\activate
  4. Install dependencies: pip install -r requirements.txt
  5. Initialize the database: flask init-db
  6. Start the server: flask run
  7. Open http://localhost:5000 in your browser

Configuring Beep.AI.Server

If you want AI features, you need to configure the connection to Beep.AI.Server:

  1. Log in as an admin user
  2. Go to Admin Dashboard > Settings
  3. Enter the Beep.AI.Server URL (e.g., http://localhost:8000)
  4. Test the connection and save
Note: Without Beep.AI.Server, you can still use document management, coding, and reporting features. AI features like chat, code suggestions, and extraction will show as unavailable.
Getting Started First Login