Pre-requisites
Before you begin the installation process for LumoKit (v1.0.0), please ensure your system meets the following requirements. These are essential for both the frontend and backend components to function correctly.
1. Frontend Pre-requisites (lumokit-frontend)
Node.js: Version 18.x or later is recommended. You can download it from nodejs.org.
Package Manager: You'll need either
npm(which comes with Node.js) oryarn.npm: Typically installed with Node.js.yarn: Can be installed via npm:npm install --global yarn.
2. Backend Pre-requisites (LumoKit Backend)
Python: Version 3.11 or later. You can download it from python.org.
PostgreSQL: Version 13 or later. This is the database used by LumoKit. Download it from postgresql.org.
Makefile: LumoKit uses a
Makefileto simplify common development tasks such as setting up the environment, running the backend server, running tests, and linting the code.Poetry: Poetry is used as the dependency and package manager for Python projects in LumoKit. It ensures deterministic builds and simplified virtual environment handling.
Docker & Docker Compose: Required for building and running the backend services, especially for a consistent development and production environment.
Docker Desktop (which includes Docker Compose) is recommended: docker.com/products/docker-desktop.
3. Essential Services & Keys
To utilize the full capabilities of LumoKit, especially its AI and blockchain interaction features, you will need:
Solana RPC Endpoint: A URL to connect to the Solana blockchain.
For development,
https://api.mainnet-beta.solana.comcan be used, but for more intensive use or production, a dedicated RPC provider (e.g., Helius, QuickNode, Alchemy) is highly recommended. This will be configured in your environment variables.
API Keys: For various third-party services integrated into LumoKit.
OpenAI API Key: Essential for the LLM capabilities. You'll need to obtain this from OpenAI. This will be configured in your backend environment variables.
Other keys might be required depending on the tools you enable or develop.
Last updated