Quick Start Guide¶

This guide will help you get AeroDB up and running on your local machine in minutes.

Prerequisites¶

Before you begin, ensure you have the following installed:

• Rust (1.70 or later): rustc --version
• Node.js (18 or later): node --version
• Git: git --version

Step 1: Clone the Repository¶

git clone https://github.com/eshanized/AeroDB.git
cd AeroDB

Step 2: Build the Backend¶

Compile the Rust backend in release mode for optimal performance:

cargo build --release

Step 3: Install Frontend Dependencies¶

Navigate to the admin console directory and install the necessary packages:

cd admin-console
npm install
cd ..

Step 4: Run the Server¶

Start the AeroDB backend server:

# Run from the root directory
cargo run --release -- serve

You should see output indicating the server is running on http://localhost:54321.

Step 5: Start the Dashboard¶

In a new terminal window, start the frontend development server:

cd admin-console
npm run dev

Open your browser and navigate to http://localhost:5173.

Step 6: First-Run Setup¶

Since this is a fresh installation, you will be redirected to the Setup Wizard.

1. Welcome: Click "Start Setup".
2. Storage: Choose where AeroDB should store its data. The defaults (./data, ./wal, etc.) are fine for development.
3. Authentication: Set your JWT expiration preferences (e.g., 24 hours).
4. Admin User: Create your super-admin account. Remember these credentials!
5. Review: Confirm your settings.
6. Complete: Click "Go to Dashboard".

Next Steps¶

Congratulations! You now have a running instance of AeroDB.

• Explore the Core Principles
• Learn about the Architecture
• Read the API Specification