Prerequisites
Before you begin, make sure you have the following installed:Docker and Docker Compose
One of these supported platforms:
- Linux-based environment
- macOS (Darwin)
- WSL under Windows
Quick Setup with Docker Compose
The easiest way to get started is using our Docker Compose setup:This single command takes care of everything you need to get started:
- Starting all required infrastructure (PostgreSQL, Kafka, ClickHouse, Temporal)
- Building the FlexPrice application image
- Running database migrations and initializing Kafka
- Starting all FlexPrice services (API, Consumer, Worker)
Accessing Services
Once setup is complete, you can access:FlexPrice API
Temporal UI
Kafka UI
ClickHouse UI
Useful Commands
Here are some common commands you might need during development:Restart FlexPrice Services
Restart FlexPrice Services
Stop All Services
Stop All Services
Clean Start
Clean Start
Build FlexPrice Image
Build FlexPrice Image
Start Only FlexPrice Services
Start Only FlexPrice Services
Running Without Docker
If you prefer to run the application directly:Connection Details
Use these credentials to connect to the various services:PostgreSQL
PostgreSQL
- Host: localhost
- Port: 5432
- Database: flexprice
- Username: flexprice
- Password: flexprice123
ClickHouse
ClickHouse
- Host: localhost
- Port: 9000
- Database: flexprice
- Username: flexprice
- Password: flexprice123
Kafka
Kafka
- Bootstrap Server: localhost:29092
- UI: http://localhost:8084 (with profile ‘dev’)
API Documentation
FlexPrice provides comprehensive API documentation in OpenAPI 3.0 format.Setting up Postman
- Open Postman
- Click on “Import” in the top left
- Select “Import File”
- Choose
docs/swagger/swagger-3-0.json
- Click “Import”
- Create a new environment for local development:
- Name: Local
- Variable:
baseUrl
- Value:
http://localhost:8080/v1
- Variable:
apiKey
- Value:
0cc505d7b917e0b1f25ccbea029dd43f4002edfea46b7f941f281911246768fe
Troubleshooting
If you encounter issues during setup or operation, try these troubleshooting steps:Docker Issues
Docker Issues
- Ensure Docker is running properly:
- Check the status of all containers:
- View logs for a specific service:
Database Connection Issues
Database Connection Issues
- Check database logs:
- Verify the database is running:
Kafka Issues
Kafka Issues
Need Help?
If you’re still experiencing issues after trying the troubleshooting steps, please:- Check our GitHub Issues for similar problems
- Join our Discord community for real-time support
- Contact us at support@flexprice.io