Quickstart

​

Requirements

• Python 3.10 or newer
• Git
• PostgreSQL for production; no database service is required for local development

​

Local setup

1. Clone Core and enter the checkout.
   git clone https://github.com/Ruoom/ruoom-core.git
   cd ruoom-core
   
2. Create and activate a virtual environment, then install Core dependencies.
   python -m venv .venv
   # PowerShell: .\.venv\Scripts\Activate.ps1
   # macOS/Linux: source .venv/bin/activate
   python -m pip install --upgrade pip
   python -m pip install -r requirements.txt
   
3. Copy the environment template and replace deployment-specific values.
   Copy-Item .env.example .env
   
   cp .env.example .env
   
   Keep DATABASE_URL empty to use the default local db.sqlite3 database. For PostgreSQL, set a URL such as:
   DATABASE_URL=postgresql://ruoom_admin:password@localhost:5432/Ruoom
   
   Use a long, stable SECRET_KEY and DEBUG=false in production.
4. Initialize the database and verify the project.
   python manage.py migrate
   python manage.py check
   
5. Optionally register the first business domain. Set RUOOM_BUSINESS_1_URL in .env, then run:
   python manage.py bootstrap_business_domain
   
   This command is idempotent; running it again updates the mapping for business 1.
6. Start the development server.
   python manage.py runserver
   

​

Add plugins

​

Deployment notes