Local Installation Guide

ℹ️ Note: We strongly recommend using Docker for installation as it provides a consistent environment and handles dependencies automatically.

Prerequisites

Required Tools

1. Install Git

   • Version control system

   • Required for cloning the repository

2. Install Node.js

   • JavaScript runtime

   • LTS version recommended

3. Install VS Code (recommended)

   • Or any preferred code editor

Docker Setup

1. Download Docker Desktop

2. Create a Docker account if needed

3. Install Docker Desktop

4. Sign in to Docker Desktop

Installation Options

Docker Installation Steps

1. Open your code editor

2. Access the terminal

   # Windows: Ctrl + ~
   # Mac: Command + ~

3. Clone and setup repository

   Mac/Linux:

   git clone https://github.com/Allinix-Labs/Allinix.git
   cd Allinix
   ./setup.sh

   Windows:

   git clone https://github.com/Allinix-Labs/Allinix.git
   cd Allinix
   ./setup.bat

4. Configure API keys as prompted

5. Visit http://localhost:3000

Manual Installation Steps

⚠️ Warning: Manual installation requires additional configuration and may be more complex.

1. Configure Environment Variables

   # Use setup.sh for guided ENV configuration
   ./setup.sh

2. Setup Frontend

   cd ./next
   npm install
   npm run dev

3. Setup Backend (in a new terminal)

   cd ./platform
   poetry install

Accessing the Application

Once installation is complete, open your browser and navigate to:

http://localhost:3000

Need Help?

If you encounter any issues:

1. Follow our detailed legacy installation guide

2. Create an issue on GitHub

ℹ️ Note: Our community is always ready to help! Don't hesitate to reach out if you need assistance.