SREDSimplify Engineering

Appearance

Quickstart ​

This is the shortest verified path to a working local SmartSRED stack.

Prerequisites ​

  • Java 21+
  • Maven 3.9+
  • Node.js 20+ recommended
  • Python 3.11+
  • uv
  • PostgreSQL
  • Redis
  • Doppler CLI
  • gum (required by start.sh)

Option A: Start Everything With Repo Helper ​

From repo root:

bash
chmod +x start.sh
./start.sh

Important behavior:

  • start.sh is interactive and requires a TTY terminal.
  • Keep this terminal open while services run.
  • Press Ctrl+C in that terminal to stop services and attempt auto-cleanup for started processes.

Option B: Start Services Manually ​

Backend ​

bash
cd backend
mvn spring-boot:run -Dspring-boot.run.profiles=dev

Python Task Engine ​

bash
cd backend/python-service
uv sync --extra dev
uv run python main.py

Frontend ​

bash
cd frontend
npm install
npm run dev

Health Checks ​

  • Frontend: http://localhost:3000
  • Backend: http://localhost:8080/actuator/health
  • Swagger UI: http://localhost:8080/swagger-ui/index.html
  • Python service: http://localhost:8000

Common Day-One Checks ​

Frontend:

bash
cd frontend
npm run lint
npm run typecheck
npm run test:unit

Backend:

bash
cd backend
mvn test

Python:

bash
cd backend/python-service
uv run pytest

Full backend business flow:

bash
bash scripts/e2e_backend_comprehensive.sh

Docs Site ​

Run the internal docs locally from docs/:

bash
cd docs
npm ci
npm run docs:dev