Website · Documentation

Quiqr

Quiqr is a local-first CMS, available as a desktop application (Electron) or web application. It provides fast content management with zero network latency while keeping your data local for privacy and developer-friendly workflows.

Key Features

Local first with max performance

• Local-First Architecture: Data stays on your computer for maximum privacy and speed
• Built-in Git Client: Publish directly to GitHub, GitLab, or BitBucket

Be creative

• Multi-SSG Support: Built for Hugo with expanding support for Quarto, Jekyll, and Eleventy
• Integrated Hugo Server: Preview your site changes instantly
• Generic Builder Support: Any system working with static serialized data can be integrated.
• Template Gallery: Quick-start with pre-built site templates

Declarative workflows

• Schema-Driven Forms: Powerful, customizable content editing interface
• Loved by AI Agents: AI love Markdown, Json and Yaml our Schema-Driven architecture.
• Advanced Prompt Templating System: Share and pre-write prompts for harnassing teams.

Quiqr Editions

The Quiqr application can run in two modes: Desktop Mode (Electron) or Server Mode (Standalone).

Use cases

• Static Site CMS (Hugo, Quarto, Eleventy and Jekyll)
• Control Panel for Terraform managed clouds
• CMS for advanced PDF's using Quarto and pandoc
• Shared LLM Prompt libraries

Support and Questions

Please don't hesitate to reach out via Discord.

Community Guidelines

Quiqr is open source and we appreciate contributions and positive feedback.

• Be welcoming and open-minded
• Communicate with empathy
• Be clear and stay on topic

For detailed information about contributing to this project, including PR requirements, testing guidelines, and the OpenSpec workflow, please see CONTRIBUTING.md.

Development

1. Clone the repository
2. Run npm install to install the dependencies
3. Run npm run _pack_embgit to get the lightweight embedded git client

Running the Desktop Mode Application locally

1. Run npm run dev to start the development server and the Electron app. The app will start and open the frontend automatically.

Running the Standalone Server Mode Application locally

1. Start a terminal to run the backend with the command: npm run dev:backend:standalone
2. Start a terminal to run the frontend with the command: npm run dev:frontend
3. Visit http://localhost:4002 in your browser.

Development on Nix

We provide a local flake for development purposes. Use it like this:

nix develop
npm install

# Run desktop
npm run dev

Packaging for Nix

Currently there is a WIP packaging fork available at https://github.com/mipmip/nixpkgs/tree/quiqr-in-nixpkgs.

You can build and run Quiqr using the following commands:

git clone https://github.com/mipmip/nixpkgs.git
cd nixpkgs
git checkout quiqr-in-nixpkgs

# Run desktop
nix run .#quiqr.desktop

# Run server
nix run .#quiqr.server

Building the Installers

1. Run npm run build to build the installers
2. The installers will be generated in the dist folder

(Optional) Manual builds

• Run electron-builder build --mac to build the macOS installer
• Run electron-builder build --win to build the Windows installer
• Run electron-builder build --linux to build the Linux installer

Installers will be generated in the dist folder.

Releasing

For information about the release process, versioning policy, and release procedures, see RELEASE.md.

About the Quiqr Project

Maintainers

• mipmip
• bert-janzwanepol

Contributors

Pim Snel	Bert-Jan	Brecht Swanenberg	Juliano Appel Klein	vsopvsop	Jose Diaz-Gonzalez
Robert A. Petit III	Vendhan Arumugam	gigot-don

Special thanks to Juliano Appel Klein who started Hokus.

Supporters