Quick Start Guide
Relevant source files
The following files were used as context for generating this wiki page:
The Quick Start Guide provides a streamlined pathway for developers and users to initialize the AI Assistant platform. This guide covers the essential steps for environment configuration, dependency installation, and service orchestration required to run the full-stack intelligent conversational application.
Sources: QUICK_START.md:1-3, README.md:1-5
System Architecture Overview
The platform operates on a 3-tier REST API architecture involving a React frontend, a Node.js orchestration service, and a Python AI service.
The diagram above illustrates the data flow and port assignments for the platform components.
Sources: README.md:10-38, PROJECT_STRUCTURE_GIT.md:10-85
Environment Prerequisites
Before initialization, ensure the following environments and tools are installed:
| Requirement | Version/Notes |
|---|---|
| Python | 3.10+ |
| Node.js | 16+ |
| MongoDB | Local or Cloud instance |
| AI Model | phi-3-mini-4k-instruct.Q4_K_M.gguf |
Sources: README.md:73-77, README.md:112-114
Setup and Installation
1. Database Initialization
Start the MongoDB instance using the provided batch script.
START_MONGODB.bat
Sources: QUICK_START.md:14, README.md:86-88
2. Configuration
Create .env files based on the .env.example templates in the respective service directories.
Node.js Auth Service (Ai-Assistant-v2/auth-service/.env):
PORT: 5001MONGODB_URI: Connection stringJWT_SECRET: Security keyPYTHON_AI_URL: http://localhost:5000
Python AI Service (backend/.env):
PORT: 5000GEMINI_API_KEY: Your API key
Sources: README.md:92-105, Ai-Assistant-v2/auth-service/server.js:12-14
3. Dependency Management
Install requirements for all three main components:
| Component | Command |
|---|---|
| Python Backend | pip install -r requirements.txt |
| Node.js Auth | npm install |
| React Frontend | npm install |
Sources: README.md:107-122
Service Orchestration
Automated Startup
The project includes a start_app.bat script that automates the cleanup of zombie processes, health checks, and service initialization.
The sequence diagram shows the internal logic of the automated startup script.
Sources: start_app.bat:8-70, QUICK_START.md:5-10
Troubleshooting Common Issues
| Issue | Cause | Resolution |
|---|---|---|
| AI Service Unavailable | Python service crashed or OOM | Restart start_app.bat or run FIX_MEMORY.bat |
| Login Stuck | MongoDB not running | Run START_MONGODB.bat |
| Slow Performance | Duplicate processes | End python.exe and node.exe in Task Manager |
Sources: QUICK_START.md:21-41
Default Credentials
For the initial login after setup:
- Username:
sabs - Password:
sabs
Sources: QUICK_START.md:46-48
The Quick Start process ensures all interdependent services (Database, ML, Auth, and UI) are synchronized and healthy before user interaction. Successful initialization results in a fully functional AI assistant capable of model switching and memory persistence.
Sources: README.md:124-135, start_app.bat:72-88