Skip to content

Quick Start

Prerequisites

  • Python 3.10+
  • An SQL Database (defaults to SQLite)

Installation

# Clone the repository
git clone https://github.com/subhayu99/DocumentAccessPOC
cd DocumentAccessPOC

# Set up virtual environment
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

Configuration

  1. Database: The system defaults to a SQLite database in ./data/db.sqlite. You can configure DATABASE_URL in config.py for PostgreSQL or other databases.
  2. JWT Secret: Change the JWT_SECRET_KEY in config.py for production use.

Running the Application

# Start the server
uvicorn main:app --reload --port 8000
The API will be available at http://localhost:8000, with interactive docs at http://localhost:8000/docs.