Getting Started
Installation
Set up your development environment for LAREX.
Installation
This guide covers setting up your development environment for LAREX. The recommended approach uses Taskfile for automated setup.
Prerequisites
Before installing LAREX, ensure you have the following tools installed:
| Tool | Version | Description |
|---|---|---|
| Docker Desktop | Latest | Container runtime for infrastructure services |
| Node.js | 20+ | JavaScript runtime for frontend development |
| Java | 21+ | JDK for backend development |
| Taskfile | Latest | Task runner for monorepo orchestration |
| Git | Latest | Version control |
Platform-Specific Installation
macOS:
brew install docker node go-task/git-task
Linux:
# Docker
curl -fsSL https://get.docker.com -o get-docker.sh && sh get-docker.sh
# Node.js (via nvm)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 20
# Taskfile
curl -sL https://taskfile.dev/install.sh | sh
# Go (for Taskfile)
sudo apt install golang-go
Windows:
# Install via Chocolatey
choco install docker-desktop nodejs-lts golang go-task
Quick Start (Recommended)
The fastest way to get started is using the automated setup:
# Clone the repository
git clone <repository-url>
cd larex
# Run one-time setup (installs dependencies, starts infrastructure)
task setup
# Start development services
task dev
The task setup command performs:
- Installs frontend dependencies (
pnpm install) - Installs Keycloak theme dependencies (
npm install) - Starts infrastructure services (PostgreSQL, Keycloak, Traefik)
- Displays instructions for starting development servers
Manual Installation
If you prefer manual control over the setup process:
1. Clone the Repository
git clone <repository-url>
cd larex
2. Install Frontend Dependencies
cd frontend
pnpm install
cd ..
3. Install Keycloak Theme Dependencies
cd keycloak-theme
npm install
cd ..
4. Start Infrastructure Services
# Start PostgreSQL, Keycloak, and Traefik
task docker:infra
# Verify services are running
task status
5. Start Development Servers
# Terminal 1: Start backend
task backend:dev
# Terminal 2: Start frontend
task frontend:dev
Verify Installation
After setup, verify everything is working:
# Check service status
task status
# Run tests
task test
Access Points
| Service | URL | Credentials |
|---|---|---|
| Frontend | http://larex.localhost | - |
| Backend API | http://api.localhost | - |
| Keycloak Admin | http://keycloak.localhost/admin | admin/admin |
| Swagger UI | http://api.localhost/swagger-ui.html | - |
Troubleshooting Installation
Port Conflicts
If any ports are already in use:
# Check what's using a port
lsof -i :3000
lsof -i :8080
lsof -i :5432
lsof -i :8090
# Stop conflicting services or configure different ports
Docker Issues
# Restart Docker Desktop
# Verify Docker is running
docker ps
# Clean up LAREX Docker resources
task docker:down:clean
task docker:infra
Node Module Issues
# Clear and reinstall
cd frontend
rm -rf node_modules pnpm-lock.yaml
pnpm install
Next Steps
- Project Structure - Understand the codebase
- Local Development - Start coding
- Docker Development - Use Docker for development