2020-01-05 11:40:21 +01:00
# 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.
2021-08-19 12:32:05 +02:00
## Using OpenSlides productively
2020-01-05 11:40:21 +01:00
2021-08-19 12:32:05 +02:00
__OpenSlides 4 (this) is currently under heavy development!__
2020-01-05 13:51:35 +01:00
2021-08-19 12:32:05 +02:00
If you are just looking to use OpenSlides in a productive manner, please refer
to the [OpenSlides 3.4 (stable) ](https://github.com/OpenSlides/OpenSlides/tree/stable/3.4.x )
2020-01-05 15:11:45 +01:00
2021-08-19 12:32:05 +02:00
__Everything else in this document is irrelevant for you__
2020-01-05 15:11:45 +01:00
2020-01-05 11:40:21 +01:00
## Installation
2021-04-24 10:20:12 +02:00
### Requirements
2020-07-16 15:20:07 +02:00
2021-04-24 10:20:12 +02:00
You need [Docker ](https://docs.docker.com/engine/install/ ) and [Docker
Compose](https://docs.docker.com/compose/install/).
2020-02-13 10:01:33 +01:00
2021-04-24 10:20:12 +02:00
### Setup OpenSlides
2020-02-13 10:01:33 +01:00
2021-08-19 12:32:05 +02:00
For a productive setup of OpenSlides follow the instructions outlined in the [OpenSlides-manage-service ](https://github.com/OpenSlides/openslides-manage-service )
2021-04-24 10:20:12 +02:00
2021-08-19 12:32:05 +02:00
## Development
2020-10-05 10:43:43 +02:00
2021-08-19 12:32:05 +02:00
For further information about developing OpenSlides, refer to [the development readme ](DEVELOPMENT.md )
2020-10-05 10:43:43 +02:00
2021-08-19 12:32:05 +02:00
### Architecture of OpenSlides 4
2020-01-05 11:40:21 +01:00
2021-08-19 12:32:05 +02:00
![System architecture of OpenSlides 4 ](https://raw.githubusercontent.com/wiki/OpenSlides/OpenSlides/OS4/img/OpenSlides4.svg )
2020-01-05 11:40:21 +01:00
2021-08-19 12:32:05 +02:00
Read more about our [concept of OpenSlides 4.0 ](https://github.com/OpenSlides/OpenSlides/wiki/DE%3AKonzept-OpenSlides-4 ).
2020-01-05 11:40:21 +01:00
2021-08-19 12:32:05 +02:00
The technical documentation about the internals, requests and functionality can be found [in the wiki ](https://github.com/OpenSlides/OpenSlides/wiki/DE%3AKonzept-OpenSlides-4 ).
2020-01-05 11:40:21 +01:00
## 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.