KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

client

★ 43 Open GitHub ↗

Easy to use voting advice application – create your own election compass. Free and open source.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Easy to use voting advice application – create your own election compass. Free and open source.

![OpenElectionCompass](https://raw.githubusercontent.com/open-election-compass/client/master/documentation/assets/title.png)

[![Join the community on GitHub Discussions](https://img.shields.io/badge/join%20the%20community-on%20GitHub%20Discussions-%23535ae8)](https://github.com/open-election-compass/client/discussions)
[![Financial contributors](https://opencollective.com/openelectioncompass/tiers/badge.svg)](https://opencollective.com/openelectioncompass)

# OpenElectionCompass

## Project state

Version 1.0.0 is still under development and coverage of automated tests is not complete. It can
already be used in production. Sign up for our [newsletter](http://eepurl.com/gRApTD) to stay in the
loop. Join us on [GitHub Discussions](https://spectrum.chat/openelectioncompass) for technical
support, questions, feature requests and chatting.

## Usage

### Organisation Guide: How to run your own election compass

Learn how to run your own election compass, how to come up with and validate theses, how to approach
parties and how to attract the attention of the public from our
[Organisation Guide](https://open-election-compass.com/guide/organisation/01-introduction.html).

### Technical Guide

Learn how the configuration files of the OpenElectionCompass are structured in our
[Technical Guide](https://open-election-compass.com/guide/technical/overview.html) or take a look at
the easy to use [Configuration Editor](https://open-election-compass.com/configurator/version-1/configuration-editor.html)
to generate configurations without needing any coding skills.

#### Deployment on your own server

Currently, it is only possible to deploy OpenElectionCompass on your own systems. However, the
process is relatively simple to be accessible for people with limited coding skills, thanks to our
[HTML Generator](https://open-election-compass.com/configurator/version-1/html-generator.html).

**[Learn more about deploying the OpenElectionCompass on your site](https://open-election-compass.com/guide/technical/deployment.html#option-1-the-simple-one-file-only-set-up)**

## Development

Install the project and it's dependencies using the package manager of your choice:

```sh
git clone git@github.com:open-election-compass/client.git
cd client
npm ci
```

### Compile for development with HMR

```sh
npm run dev
```

### Compiles and minify for production

```sh
npm run build:demo # Build demo
npm run build:lib # Build the actual library / client
npm run build:nuxt # Build the Nuxt.js module
npm run build # runs all builds sequentially
```

### Run tests

```sh
npm run test:unit
npm run test:e2e
npm run test # run all both test suites sequentially
```

### Run linting

```sh
npm run lint # run ESLint
npm run lint:style # run Stylelint
```

client

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README