Installation

This guide covers installation for both the backend and frontend components of BGC Viewer.

Prerequisites

• Python 3.8 or higher
• Node.js 18 or higher
• Rust (optional, for building extensions)

Backend Installation

Using pip

cd backend
pip install -e .

Using uv (recommended)

cd backend
uv pip install -e .

Development Installation

For development with all dependencies:

cd backend
pip install -e ".[dev]"

Frontend Installation

Install Dependencies

cd frontend
npm install

Development Server

npm run dev

Build for Production

npm run build

Docker Installation

You can also run BGC Viewer using Docker:

docker-compose up

This will start both the backend API and frontend development server.

Verify Installation

Backend

cd backend
python -m bgc_viewer.app

Visit http://localhost:5000/api/health to verify the API is running.

Frontend

cd frontend
npm run dev

Visit http://localhost:5173 to see the application.

Troubleshooting

Rust Extensions

If you encounter issues with Rust extensions, you can disable them:

export USE_RUST_EXTENSIONS=0
pip install -e .

Port Conflicts

If the default ports are in use, you can change them:

Backend:

FLASK_RUN_PORT=8000 python -m bgc_viewer.app

Frontend:

npm run dev -- --port 3000

Next Steps

• Quick Start Guide
• Configuration Options