Getting Started with Allinix

Get started with Allinix

This guide will walk you through the steps to set up Allinix on your local machine and start building your own AI agents.

Prerequisites

Before getting started, make sure you have the following prerequisites installed:

• Visual Studio Code or your preferred code editor

• Node.js (v18 or higher)

• Git

• Docker

Installation

1. Clone the Repository

   Open your terminal and run the following command to clone the Allinix repository:

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

2. Run Setup Script

   For Mac/Linux:

   ./setup.sh

   For Windows:

   ./setup.bat

   The setup script will guide you through the process of configuring your environment, setting up the database, and initializing the backend and frontend.

3. Configure Environment

   • Open the .env file in the project root directory.

   • Add your required API keys.

   • Follow the setup prompts to configure your environment.

4. Start the Development Server

   npm run dev

   This command will start the development server and launch Allinix in your default browser.

5. Access Allinix

   Open your browser and visit http://localhost:3000 to access the Allinix application.

Next Steps

Congratulations! You have successfully set up Allinix on your local machine. Here are some next steps to explore:

• Read the documentation to learn more about Allinix's features and how to use them effectively.

• Create your first AI agent and define its objectives.

• Automate workflows by connecting different tasks and actions.

• Explore the multi-language support and customize your agent's language preferences.

• Monitor your agent's performance using the built-in analytics dashboard.

If you have any questions or need assistance,refer to the documentation.

Happy building! 🚀