Guides & reference

Quick Start Guide

Welcome to QS Asset Management! This guide helps you orchestrate and deploy a secure development or evaluation instance of the platform in under 10 minutes using Docker Compose.

1. Setup Environment

Clone the repository, navigate to the project directory, and initialize the configuration profile using the preconfigured template:

git clone https://github.com/neurqai/qsasset.git
cd qsasset
cp .env.example .env

2. Launch Services

Execute the high-performance local production bundle of DB, API, and Web workspaces immediately:

docker compose -f docker-compose.prod.yml up -d --build

3. Database Migrations & Seeds

Run the initialization pipelines inside the API container to configure database schemas and import rich enterprise seed datasets:

docker compose -f docker-compose.prod.yml exec api npm run db:migrate
docker compose -f docker-compose.prod.yml exec api npm run db:seed

4. Verify Platform Access

Once the service logs signal stable system initialization, open your browser and navigate to the portals:

• 🖥️ **Web Landing Page**: [http://localhost:3000](http://localhost:3000)
• 🔐 **Platform Login**: [http://localhost:3000/login](http://localhost:3000/login)
• 📊 **API Health Endpoint**: [http://localhost:4100/health](http://localhost:4100/health)