Onboarding Guide

​

Welcome to V01T

​

Prerequisites

• Python 3.9+
• PostgreSQL 12+
• Node.js 18+
• Docker (optional, for local development)

​

Step 1: Clone and Install

# Clone the repository
gh repo clone v01t-io/server

cd server

# Create virtual environment
python -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Create .env file
cp .env.example .env

​

Step 2: Configure Database

DATABASE_URL=postgresql://user:password@localhost:5432/v01t_db

python api/manage.py migrate

​

Step 3: Create a Superuser

python api/manage.py createsuperuser

​

Step 4: Start the Development Server

python api/manage.py runserver

​

Step 5: Seed Your First Application

​

Option A: Seed the Devarno Ecosystem

python api/manage.py seed_ecosystem

• Application: devarno-ecosystem
• Data source: ecosystem organizations
• 18 NodeData records from DEVARNO.json

​

Option B: Seed the Flight Path Blog

python api/manage.py seed_flight_path

• Application: flight-path
• Data source: blog articles
• 4 ArtefactData records with sample blog content

​

Step 6: Access the Public API

​

List all applications

curl http://localhost:8000/trace/applications/

​

Fetch ecosystem nodes

curl http://localhost:8000/trace/devarno-ecosystem/node/

​

Fetch blog articles

curl http://localhost:8000/trace/flight-path/artefact/?status=published

​

Step 7: Connect Your Frontend

import { createV01tClient } from '@v01t/client';

const client = createV01tClient({
  baseUrl: 'http://localhost:8000',
});

// Fetch data
const nodes = await client.getNodes('devarno-ecosystem');
console.log(nodes.data);

​

Step 8: Explore the Admin Interface

• View all applications and data sources
• Create and edit components manually
• Monitor sync status
• Configure access tokens

​

Common Tasks

​

Register a New Application

​

Sync Data from Notion

1. Get your Notion API token from notion.so/my-integrations
2. Create a Data Resource of type “Notion”
3. Link it to a Data Source in your application
4. Run the sync command:

python api/manage.py appsync --app=my-application

​

Enable API Access

1. Go to Data Vaults
2. Select your vault
3. Check API access enabled
4. Save

​

Environment Variables

​

Troubleshooting

​

Migration errors

# Reset database (dev only!)
python api/manage.py flush --no-input

# Re-run migrations
python api/manage.py migrate

​

Port already in use

# Use a different port
python api/manage.py runserver 8001

​

API returning 404

1. Verify the application slug exists: python api/manage.py inspect_sync_sources
2. Check that the application has active components
3. Ensure api_access_enabled=True on the vault

​

Next Steps

• Read the Integration Guide to connect V01T to your app
• Check the Commands Reference for all management commands
• Explore the Architecture to understand the system
• See Ecosystem Integration for a real-world example

​

Getting Help

• Check the Architecture Guide
• Review the API Documentation
• See Operations Runbooks