OpenSlides/README.md
2021-08-08 18:01:53 +02:00

2.1 KiB

OpenSlides

What is OpenSlides?

OpenSlides is a free, web based presentation and assembly system for managing and projecting agenda, motions and elections of an assembly. See https://openslides.com for more information.

Note: OpenSlides 4 is currently under development.

Architecture of OpenSlides 4

System architecture of OpenSlides 4

Read more about our concept of OpenSlides 4.0.

Installation

Requirements

You need Docker and Docker Compose.

Setup OpenSlides

Go to a nice place in your filesystem, get the OpenSlides manage tool from GitHub and make it executable. E. g. run:

$ wget https://github.com/OpenSlides/openslides-manage-service/releases/download/latest/manage
$ chmod +x manage

Create configuration files:

$ ./manage setup --cwd  # TODO: Provide instruction using XDG_DATA_PATH.

Build and start Docker containers. According to your Docker installation you may have to run this as root:

$ docker-compose up --detach

Setup initial-data:

$ ./manage initial-data

Now you can open https://localhost:8000 and use OpenSlides. # TODO: Enable HTTPS support

To stop OpenSlides run:

$ docker-compose stop

To remove all containers including the complete database run:

$ docker-compose rm

Installation with ...

TODO: Provide a short instruction for setup with Docker Swarm or Kubernetes or something else.

Development setup

For a development setup, refer to the development docs

Used software

OpenSlides uses the following projects or parts of them:

  • Several Python packages (see TODO)
  • Several JavaScript packages (see TODO)
  • TODO

License and authors

OpenSlides is Free/Libre Open Source Software (FLOSS), and distributed under the MIT License, see LICENSE file. The authors of OpenSlides are mentioned in the AUTHORS file.