Local Setup Quick Guide
Use this page if you are setting up the Rahva Raamat backend for the first time. Follow the steps in order.
Setup path (start here)
| Step | What to do | Doc |
|---|---|---|
| 1 | Understand the repo layout (admin, api, console, common) | Project Structure |
| 2 | Install via Docker (recommended) or tools manually | Docker Setup / Environment Setup |
| 3 | Learn the database tables and relationships | Database Schema |
| 4 | Configure main-local, params-local, and modules | Configuration Files |
| 5 | Apply / understand filesystem migration notes | Migration Guide |
| 6 | Run and verify the app | Deployment Guide |
After the app runs
- Auth — Authentication & Authorization, Registration Flow
- Orders & payments — Order Purchase Flow, Payment System
- Integrations — External Integrations, NAV Integration
- Ops — Console Commands, Cron Jobs, Backups
- Troubleshoot — FAQ & Troubleshooting
Related quick links
- Onboarding Pack — KT, triage playbook, first 30 days
- Project Overview — business context and architecture
- API Documentation — HTTP API reference
- Admin Panel — back-office UI guide
- Elasticsearch Spool — search import / spool jobs
- Search Functionality — catalog search, autocomplete, ranking
- Elasticsearch Reliability — 503 downtime contract / QA
- Hotline & OIDC — Hotline module and OpenID Connect