Skip to content

A simple web application for testing and demoing embedded Polis conversations. The name "oikia" (Greek: οἰκία) relates to Polis and means "family" or "household."

Notifications You must be signed in to change notification settings

compdemocracy/oikia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oikia - Polis Embed Tester

A simple web application for testing and demoing embedded Polis conversations. The name "oikia" (Greek: οἰκία) relates to Polis and means "family" or "household."

Features

  • Configure Polis embed parameters through an intuitive form
  • Configurable Polis server domain - Test against production (https://pol.is) or local development servers (http://localhost:5000)
  • Live preview of embedded conversations
  • Support for all key Polis embed parameters:
    • domain (Polis server URL, defaults to https://pol.is)
    • conversation_id (required)
    • xid (External ID for participant persistence)
    • site_id
    • page_id
    • And more
  • Copy embed code to clipboard
  • Generate shareable URLs with pre-configured parameters
  • URL parameter support for direct linking to configured embeds
  • Optional toggle for the experimental Polis alpha client (/alpha/embed.js)

Getting Started

Prerequisites

  • Node.js (v18 or higher recommended)
  • npm

Installation

npm install

Development

Run the development server:

npm run dev

This will start the Vite dev server, typically at http://localhost:5173

Build

Build for production:

npm run build

Preview Production Build

npm run preview

Usage

Basic Usage

  1. Configure the Polis server domain (defaults to https://pol.is)
    • Use https://pol.is for production Polis
    • Use http://localhost:5000 (or your port) for local development
  2. Enable Use Alpha Client if you want to load the experimental /alpha/embed.js script (disabled by default)
  3. Enter a Polis conversation ID (required)
  4. Optionally add additional parameters like XID for participant tracking
  5. Click "Show Embed Preview" to see the live embed
  6. Use "Copy Embed Code" to get the HTML snippet for your own site

URL Parameters

You can create direct links to pre-configured embeds by adding URL parameters:

http://localhost:5173/?conversation_id=2demo6huja&xid=user123

For testing against a local Polis instance:

http://localhost:5173/?domain=http://localhost:5000&conversation_id=2demo6huja

Supported parameters:

  • domain (Polis server URL)
  • conversation_id
  • xid
  • site_id
  • page_id
  • ucv
  • ucw
  • ucp
  • subscribe_type
  • use_alpha (set to true to load /alpha/embed.js)

About Polis Embeds

Polis is a real-time system for gathering, analyzing and understanding what large groups of people think in their own words. This tool helps you test different embed configurations.

For more information about Polis embeds, see:

Technology Stack

  • React 19
  • Vite 7
  • Pure CSS (no framework dependencies)

License

MIT

About

A simple web application for testing and demoing embedded Polis conversations. The name "oikia" (Greek: οἰκία) relates to Polis and means "family" or "household."

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published