Go to file
Norman Jäckel b4a034d900 Switched to GitHub Container Registry. 2021-04-30 13:54:05 +02:00
.github Switched to GitHub Container Registry. 2021-04-30 13:54:05 +02:00
dev-commands Structured fields, updated repos 2020-11-03 12:14:09 +01:00
docker example- and initial data 2021-04-29 14:09:21 +02:00
docs example- and initial data 2021-04-29 14:09:21 +02:00
logo Updated improved OpenSlides logo. 2019-09-13 13:25:41 +02:00
openslides-auth-service@10d78e1f03 Update subprojects to current master 2021-04-26 16:36:27 +02:00
openslides-autoupdate-service@2bc88271b3 Update subprojects to current master 2021-04-26 16:36:27 +02:00
openslides-backend@4470bb8074 Update subprojects to current master 2021-04-26 16:36:27 +02:00
openslides-client@51629fad1e Update subprojects to current master 2021-04-26 16:36:27 +02:00
openslides-datastore-service@488b22458b Update subprojects to current master 2021-04-26 16:36:27 +02:00
openslides-manage-service@d1bd161936 Switched to GitHub Container Registry. 2021-04-30 13:54:05 +02:00
openslides-media-service@6db3ecb09e Update 2021-02-04 15:35:15 +01:00
openslides-permission-service@c40703f752 Update subprojects to current master 2021-04-26 16:36:27 +02:00
proxy OS4: prod setup 2021-04-01 10:55:06 +02:00
.gitignore OS4 productive setup changes 2021-04-08 12:52:59 +02:00
.gitmodules OS4: prod setup 2021-04-01 10:55:06 +02:00
AUTHORS changed email 2019-08-08 08:07:29 +02:00
CHANGELOG.md Prepared repository for OpenSlides 4. Removed OpenSlides 3 code. 2020-01-05 14:16:23 +01:00
DEVELOPMENT.md Add https-info and enhance work-in-submodules doc 2020-08-14 11:09:49 +02:00
LICENSE Prepared repository for OpenSlides 4. Removed OpenSlides 3 code. 2020-01-05 14:16:23 +01:00
Makefile Update submodules and use Caddy 2021-03-18 13:25:12 +01:00
README.md Switched to GitHub Container Registry. 2021-04-30 13:54:05 +02:00
db.sh Permission Service 2020-11-17 07:49:14 +01:00
dc-dev.sh Prod setup 2020-10-28 08:46:03 +01:00

README.md

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 and get the OpenSlides manage tool.

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 http://localhost:8000 and use OpenSlides.

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.