Quick Start

Set up your development environment and create your first sparQ app in minutes.

Prerequisites

Before you begin, make sure you have the following installed:

Installation

Clone the sparQ app and set up your environment:

# Clone sparQ
git clone https://github.com/sparqone/sparq
cd sparq

# Set up virtual environment and install dependencies
make setup
source venv/bin/activate  # Windows: venv\Scripts\activate

Start the Development Server

Run the development server:

make run

Verify the console shows no errors. You should see output like:

 * Running on http://127.0.0.1:8000
 * Restarting with stat
 * Debugger is active!

Load Demo Data

Before building your first app, let's load some demo data to see sparQ in action:

  1. Open http://localhost:8000 in your browser
  2. Log in to the Control Panel as:
    • Username: sysadmin
    • Password: password
  3. In the left sidebar, click Demo Data → Load Demo Data
  4. This seeds the app with a demo company and sample data
  5. Click the avatar (top-right) and Log out

Verify the Installation

Now log in as a business user to verify everything is working:

  1. Log in with:
    • Email: maria@example.com
    • Password: password
  2. Browse around—you should see the demo company data loaded
  3. Check Dashboard, Sales, Team, and other modules

If you see demo data in the modules, your installation is working correctly!

Create Your First App

Now you're ready to build. Use the scaffolding command to create a new app:

cd sdk
make app name=hello

This creates a new app in data/modules/apps/hello/ with the following structure:

hello/ ├── __init__.py ├── __manifest__.py # App metadata (includes mappid) ├── module.py # Lifecycle hooks ├── controllers/ │ └── main.py # Flask routes ├── models/ │ └── __init__.py ├── views/ │ ├── templates/ │ │ └── hello/ │ │ ├── desktop/ │ │ │ └── index.html │ │ └── mobile/ # Optional mobile templates │ └── assets/ │ └── css/ └── lang/ └── en.json

Your app will be accessible at /m/{mappid}/hello where mappid is the auto-generated 6-character identifier in your manifest.

Next Steps