Installation

Welcome to Airclou! This guide will walk you through the installation process and help you get your workspace up and running in minutes.

System Requirements

Before you begin, make sure your system meets the following requirements:

• Node.js: Version 18.0 or higher
• Package Manager: npm, yarn, or pnpm
• Operating System: macOS, Windows, or Linux
• Browser: Modern browser (Chrome, Firefox, Safari, or Edge)

Hardware Requirements

• RAM: Minimum 4GB, recommended 8GB or more
• Storage: At least 500MB of free disk space
• Network: Stable internet connection for initial setup

Quick Start

The fastest way to get started with Airclou is to use our installation script:

npm create airclou@latest

This command will:

1. Download the latest Airclou templates
2. Set up your project structure
3. Install all required dependencies
4. Configure your environment

Alternative Installation Methods

If you prefer more control over the installation process, you can also install manually:

# Clone the repository
git clone https://github.com/airclou/airclou.git

# Navigate to the project directory
cd airclou

# Install dependencies
pnpm install

# Start the development server
pnpm dev

Configuration

After installation, you’ll need to configure your workspace. Create a .env file in your project root:

# Database Configuration
DATABASE_URL="postgresql://user:password@localhost:5432/airclou"

# Authentication
AUTH_SECRET="your-secret-key-here"
AUTH_URL="https://auth.airclou.com"

# Application Settings
NODE_ENV="development"
PORT=3000

Environment Variables

Here are the key environment variables you should configure:

Variable	Description	Required
DATABASE_URL	PostgreSQL connection string	Yes
AUTH_SECRET	Secret key for JWT tokens	Yes
AUTH_URL	Authentication service URL	Yes
NODE_ENV	Environment (development/production)	No
PORT	Application port number	No

Verification

To verify your installation is working correctly, run:

pnpm dev

Then open your browser and navigate to http://localhost:3000. You should see the Airclou welcome screen.

Troubleshooting Common Issues

Port Already in Use

If you see an error about the port being in use, you can specify a different port:

PORT=3001 pnpm dev

Database Connection Failed

Make sure your PostgreSQL server is running and the connection string in your .env file is correct:

# Test your database connection
psql $DATABASE_URL

Permission Denied

On Linux or macOS, you may need to use elevated permissions for certain operations:

sudo npm install -g pnpm

Next Steps

Now that you have Airclou installed and running, you’re ready to explore:

• Quick Start Guide - Learn the basics in 5 minutes
• Core Concepts - Understand how Airclou works
• Your First Project - Build something with Airclou
• Configuration Guide - Deep dive into settings

Getting Help

If you run into any issues during installation:

• Check our FAQ
• Visit our Community Forum
• Join our Discord Server
• Email us at support@airclou.com

We’re here to help you succeed with Airclou!