Fulkrum - Build LLM Apps Easily

English | 中文 | 日本語 | 한국어

⚡Quick Start

Download and Install NodeJS >= 18.15.0

1. Install Fulkrum

   npm install -g Fulkrum

2. Start Fulkrum

   npx Fulkrum start

   With username & password

   npx Fulkrum start --Fulkrum_USERNAME=user --Fulkrum_PASSWORD=1234

3. Open http://localhost:3000

🐳 Docker

Docker Compose

1. Go to docker folder at the root of the project
2. Copy .env.example file, paste it into the same location, and rename to .env
3. docker-compose up -d
4. Open http://localhost:3000
5. You can bring the containers down by docker-compose stop

Docker Image

1. Build the image locally:

   docker build --no-cache -t Fulkrum .

2. Run image:

   docker run -d --name Fulkrum -p 3000:3000 Fulkrum

3. Stop image:

   docker stop Fulkrum

👨‍💻 Developers

Fulkrum has 3 different modules in a single mono repository.

• server: Node backend to serve API logics
• ui: React frontend
• components: Third-party nodes integrations

Prerequisite

• Install PNPM

  npm i -g pnpm

Setup

1. Clone the repository

   git clone https://github.com/FulkrumAI/Fulkrum.git

2. Go into repository folder

   cd Fulkrum

3. Install all dependencies of all modules:

   pnpm install

4. Build all the code:

   pnpm build

5. Start the app:

   pnpm start

   You can now access the app on http://localhost:3000

6. For development build:

   • Create .env file and specify the VITE_PORT (refer to .env.example) in packages/ui

   • Create .env file and specify the PORT (refer to .env.example) in packages/server

   • Run

     pnpm dev

   Any code changes will reload the app automatically on http://localhost:8080

🔒 Authentication

To enable app level authentication, add Fulkrum_USERNAME and Fulkrum_PASSWORD to the .env file in packages/server:

Fulkrum_USERNAME=user
Fulkrum_PASSWORD=1234

🌱 Env Variables

Fulkrum support different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Read more

📖 Documentation

Fulkrum Docs

🌐 Self Host

Deploy Fulkrum self-hosted in your existing infrastructure, we support various deployments

• AWS

• Azure

• Digital Ocean

• GCP

• • Railway

    

  • Render

    

  • HuggingFace Spaces

  • Elestio

    

  • Sealos

    

  • RepoCloud

    

📄 License

Source code in this repository is made available under the Apache License Version 2.0.