79 lines
1.7 KiB
Markdown
79 lines
1.7 KiB
Markdown
# Neural Sync - AI Project Manager
|
|
|
|
This is a custom internal AI Project Management platform designed to align cognitive processes and manage AI experiments efficiently. It focuses on speed and model adaptation, providing a centralized "AI Kitchen" for the team.
|
|
|
|
## Project Structure
|
|
|
|
- **Backend**: Python (FastAPI) with PostgreSQL (pgvector) for vector storage.
|
|
- **Frontend**: Vue 3 + TypeScript + Naive UI (Web-only, Desktop First).
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.10+
|
|
- Node.js 18+
|
|
- PostgreSQL 15+ (running on port 5435 by default)
|
|
- `pgvector` extension for PostgreSQL
|
|
|
|
## Setup Instructions
|
|
|
|
### 1. Database Setup
|
|
|
|
Ensure PostgreSQL is running and create the database:
|
|
|
|
```sql
|
|
CREATE DATABASE neural_sync;
|
|
\c neural_sync
|
|
CREATE EXTENSION vector;
|
|
```
|
|
|
|
### 2. Backend Setup
|
|
|
|
Navigate to the `backend` directory:
|
|
|
|
```bash
|
|
cd backend
|
|
python -m venv venv
|
|
source venv/bin/activate # On Windows: venv\Scripts\activate
|
|
pip install -r requirements.txt
|
|
pip install asyncpg alembic pgvector # Install key dependencies if not in requirements.txt
|
|
```
|
|
|
|
Run database migrations:
|
|
|
|
```bash
|
|
alembic upgrade head
|
|
```
|
|
|
|
Start the backend server:
|
|
|
|
```bash
|
|
uvicorn app.main:app --reload --port 8000
|
|
```
|
|
|
|
### 3. Frontend Setup
|
|
|
|
Navigate to the `frontend` directory:
|
|
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
```
|
|
|
|
Start the frontend development server:
|
|
|
|
```bash
|
|
npm run dev -- --host
|
|
```
|
|
|
|
Access the frontend at: `http://localhost:5173`
|
|
|
|
## Features
|
|
|
|
- **Signal Dashboard**: Monitor external signals and system status.
|
|
- **Experiment Board**: Manage AI experiments with hypothesis tracking and scoring.
|
|
- **Context Manager**: Define and manage cognitive nodes (RAG slices, rules).
|
|
|
|
## Notes
|
|
|
|
- The interface is currently optimized for **Desktop Web** usage only. Mobile support is not a priority.
|