Skip to main content
Get SGIVU up and running on your local machine in minutes using Docker Compose. This guide will have you exploring the platform quickly.

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Docker (20.10 or later)
  • Docker Compose (v2.0 or later)
  • Git (for cloning the repository)
  • At least 4GB of available RAM
  • At least 10GB of free disk space

​
Quick Start

1

Clone the repository

Clone the SGIVU repository to your local machine:
git clone https://github.com/your-org/sgivu.git
cd sgivu
2

Navigate to Docker Compose directory

Navigate to the Docker Compose infrastructure directory:
cd infra/compose/sgivu-docker-compose
3

Create environment file

Copy the development environment template:
cp .env.dev.example .env.dev
The default values in .env.dev.example are pre-configured for local development and work out of the box.
4

Start the platform

Launch the entire SGIVU stack with a single command:
chmod +x run.bash
./run.bash --dev
This command will:
  • Pull all required Docker images
  • Start all microservices (auth, gateway, user, client, vehicle, purchase-sale)
  • Initialize databases (PostgreSQL, MySQL)
  • Start Redis for session management
  • Launch the ML service (FastAPI)
  • Start Eureka service discovery
  • Start the Config Server
  • Optionally start Zipkin for distributed tracing
5

Wait for services to start

The initial startup may take 2-5 minutes as services initialize and register with Eureka. Monitor the startup process:
docker compose -f docker-compose.dev.yml logs -f
You can also check service status:
docker compose -f docker-compose.dev.yml ps
6

Access the services

Once all services are running, you can access them at the following URLs:
ServiceURLDescription
Gatewayhttp://localhost:8080Main API gateway (BFF)
Authhttp://localhost:9000Authentication service
Confighttp://localhost:8888Configuration server
Discoveryhttp://localhost:8761Eureka service registry
User Servicehttp://localhost:8081User management
Client Servicehttp://localhost:8082Client management
Vehicle Servicehttp://localhost:8083Vehicle inventory
Purchase-Salehttp://localhost:8084Transaction management
ML Servicehttp://localhost:8000Machine learning API
Zipkinhttp://localhost:9411Distributed tracing
Frontendhttp://localhost:4200Angular application
7

Verify installation

Check that Eureka shows all registered services:
curl http://localhost:8761
Test the gateway health endpoint:
curl http://localhost:8080/actuator/health

​
Stopping the Platform

To stop all services: 
docker compose -f docker-compose.dev.yml down
To stop and remove all data (including databases): 
docker compose -f docker-compose.dev.yml down -v

​
Next Steps

Installation

Learn about detailed installation options and prerequisites

Configuration

Explore configuration options and environment variables

Docker Deployment

Understand the Docker Compose architecture

Architecture

Dive into SGIVU’s microservices architecture

​
Troubleshooting

​
Port conflicts

If you see port conflict errors, ensure no other services are using the required ports (8080, 9000, 8888, 8761, etc.): 
lsof -i :8080

​
Services not starting

Check the logs for specific services: 
docker compose -f docker-compose.dev.yml logs sgivu-gateway
docker compose -f docker-compose.dev.yml logs sgivu-auth

​
Config Server issues

If services can’t connect to the Config Server, verify it’s running: 
docker compose -f docker-compose.dev.yml ps sgivu-config
curl http://localhost:8888/actuator/health

​
Database connection issues

Ensure PostgreSQL and MySQL are healthy: 
docker compose -f docker-compose.dev.yml ps sgivu-postgres
docker compose -f docker-compose.dev.yml ps sgivu-mysql

Build docs developers (and LLMs) love

Get started for freeTalk to us