Skip to main content

# Quick start

LightningRAG is a Go (Gin) + Vue 3 full-stack project. Run the API and admin UI on your machine, then explore APIs via Swagger.

## Prerequisites

- Node.js > v18.16.0
- Go >= 1.22
- Git, and an IDE (GoLand or VS Code recommended)

## Backend (server)

Open the server directory as the project root in your IDE (not the repository root). Then install tools and run:

    git clone https://github.com/LightningRAG/LightningRAG.git
    cd LightningRAG/server
    go generate
    go run .

Default API listens on port 8888. Configure databases and Redis via config files under server/ as needed.

## Frontend (web)

From the web directory, install dependencies and start the dev server. Point the UI at your local API base URL in environment or proxy settings if required.

    cd LightningRAG/web
    npm install
    npm run serve

## Swagger API docs

Install swag, run swag init inside server/, restart the API, then open /swagger/index.html on the API host.

    go install github.com/swaggo/swag/cmd/swag@latest
    cd LightningRAG/server
    swag init

## Docker & compose

For containerized dependencies or full stacks, see deploy/docker-compose in the repository. Adjust profiles and .env for your vector store and services.

## Next steps

Read the repository README for Casbin menus, code generation, plugin layout, and RAG module details. Commercial use follows Apache 2.0 with the notices described there.

Commercial license & contact →

Open usage guide →