Getting Started

Caution

This is an experimental UI Console and still under active development.

Prerequisites

• Node.js (v18 or later)
• Go (v1.20 or later)
• Aerospike Vector Search instance
• asvec CLI (https://github.com/aerospike/asvec)

How to Run the Application

To run this application, you'll need to:

1. Install dependencies:

   npm install --legacy-peer-deps
   

2. Start the Go API Server server:

   cd server
   go run main.go
   

3. Start the Next.js frontend:

   npm run dev
   

The Go backend will run on port 8080, and the frontend will connect to it using the NEXT_PUBLIC_API_URL environment variable.

Architecture Overview

This implementation follows a client-server architecture:

Go API Server

• Provides RESTful API endpoints built on top of asvec CLI(https://github.com/aerospike/asvec)
• Handles data processing and business logic
• Includes proper error handling, debug logging and CORS support

React Console

• Uses React hooks for state management and data fetching
• Implements loading states with skeleton loaders
• Provides error handling for API failures

Configuration File & Env Vars

Go API Server

The server will use the default settings configured in your asvec.yaml file which is located by default at /etc/aerospike/asvec.yaml

React Console

The UI application uses the following environment variable:

NEXT_PUBLIC_API_URL=http://localhost:8080

You can set this in a .env.local file in the root directory. If not set, the application will default to http://127.0.0.1:8080, which works for local development without any configuration.