Build from source

If you

• encounter compatibility issues during installation;
• want to contribute to this project;
• think compiling projects is cool.

Then this document will teach you how to compile the Lyvo browser extension from source code. Don’t worry, it’s all very simple.

Prerequisites

• You need to install Git, a distributed version control system, which we use to fetch and manage source code.
• You need to install the Node.js environment, because Lyvo and the Lyvo browser extension are written in JavaScript/TypeScript and need to be compiled in this environment.
• You also need to install pnpm, an efficient package management tool, which we will use to install dependencies and compile code.

Compiling the Lyvo Framework

1. Clone the code repository to your local machine: git clone https://github.com/LyvoAI/lyvo.
2. Enter the lyvo directory: cd lyvo.
3. Switch to the branch you want, git checkout main for general users, and git checkout develop for developers.
4. Install dependencies using pnpm: pnpm install.
5. Link the lyvo dependency globally for reference later: pnpm link -g.
6. Compile the Lyvo framework: pnpm run build.

Compiling the Lyvo Browser Extension

1. Clone the code repository to your local machine: git clone https://github.com/LyvoAI/lyvo-browser-extension-template.
2. Enter the lyvo-browser-extension-template directory.
3. Switch to the branch you want.
4. Install dependencies using pnpm: pnpm install.
5. Link the lyvo dependency to the current directory: pnpm link @lyvo-ai/lyvo -g.
6. Compile the Lyvo browser extension: pnpm run build.
7. You can find the compiled output in the dist directory.