DocReview360

DocReview360 is a document review app with a FastAPI backend, a React frontend, and a CLI. It helps teams route documents through review, approvals, and audit logging.

Alpha release

The current PyPI release is an alpha package. The base install is the lightweight web review app: FastAPI backend, docreview360 CLI, SQLite support, TipTap authoring/review, core notifications, reviewer management, and the packaged frontend build asset when release artifacts are built with a frontend bundle. ML, async workers, enterprise auth, production database drivers, and advanced editor/collaboration paths are optional extras.

python -m pip install --pre docreview360
docreview360 init
docreview360 migrate
docreview360 serve

Add runtime capabilities later with extras, then configure them in the frontend Configuration area:

python -m pip install --pre "docreview360[postgres]"
python -m pip install --pre "docreview360[ml-cpu]"
python -m pip install --pre "docreview360[full]"
docreview360 capabilities

Quick start

Requirements:

• Python 3.11 or 3.12
• Node 18+ for frontend source development
• uv recommended for environment management

Backend:

git clone https://github.com/eputnam77/DocReview360.git
cd DocReview360
uv venv --python 3.12
source .venv/bin/activate
uv pip install -e ".[dev,test,security]"
DOCREVIEW360_ENV=dev python -m uvicorn docreview360.api:app --reload --host 0.0.0.0 --port 8000

Frontend:

cd frontend
npm install --legacy-peer-deps
printf "NEXT_PUBLIC_API_BASE=http://localhost:8000\n" > .env.local
npm run dev

Windows PowerShell:

uv venv --python 3.12
.venv\Scripts\Activate.ps1
python -m pip install -e ".[dev,test,security]"
$env:DOCREVIEW360_ENV="dev"
python -m uvicorn docreview360.api:app --reload --host 0.0.0.0 --port 8000

Log in with alice / password or bob / password in local development.

For the full setup flow, see docs/getting_started.md.

Install options

Install the lightweight web app from PyPI:

python -m pip install --pre docreview360
docreview360 init
docreview360 migrate
docreview360 serve

Install optional runtime capabilities:

python -m pip install --pre "docreview360[postgres]"
python -m pip install --pre "docreview360[worker]"
python -m pip install --pre "docreview360[ml-cpu]"
python -m pip install --pre "docreview360[saml]"

Install from source for full-stack development:

uv pip install -e ".[dev,test,security]"

Need a plain venv flow instead of uv? See docs/getting_started.md.

Configuration

Keep the README focused. Use the docs for configuration detail.

• Environment variables: docs/environment_variables.md
• Settings reference: docs/settings.md
• Deployment guide: docs/deployment.md
• CLI reference: docs/cli.md

Run the setup wizard to generate docreview360.yaml:

docreview360 init

Testing and quality

Quality checks, security scans, and E2E commands now live in one place:

• docs/testing_and_quality.md

Product notes

• Existing endpoints remain available without a prefix.
• Versioned aliases are supported at /api/v1/*.
• AI assistance is optional.
• The app is not legal advice and is not positioned as a certified regulatory compliance system.

Performance baseline details live in docs/performance_baseline.md.

Packaging and release

Release packaging details live in docs/release_packaging.md.

More docs

• API overview: docs/api_overview.md
• Developer guide: docs/developer.md
• E2E guide: docs/e2e.md
• Federal Style Validator: docs/federal-style-validator.md
• Operations and deployment: docs/deployment.md

Governance

• Terms: TERMS.md
• Contributing: CONTRIBUTING.md
• Code of conduct: CODE_OF_CONDUCT.md
• License: LICENSE