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.
|
|
|
|
|
|
|
|
|
|
__Note: OpenSlides 4 is currently under development.__
|
|
|
|
|
|
2020-01-05 13:51:35 +01:00
|
|
|
### Architecture of OpenSlides 4
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-01-05 11:40:21 +01:00
|
|
|
|
2020-01-05 15:11:45 +01:00
|
|
|
Read more about our [concept of OpenSlides 4.0](https://github.com/OpenSlides/OpenSlides/wiki/DE%3A-Konzept-OpenSlides-4).
|
|
|
|
|
|
|
|
|
|
|
2020-01-05 11:40:21 +01:00
|
|
|
## Installation
|
|
|
|
|
|
2020-07-16 15:20:07 +02:00
|
|
|
NOTE: Do not use prod at the moment. It will not work. Please refer to the DEVELOPMENT.md!
|
|
|
|
|
|
2020-02-13 10:01:33 +01:00
|
|
|
Required software: Docker, docker-compose, make, git
|
|
|
|
|
|
|
|
|
|
For a non-development setup, clone this repo and run it via docker compose. The make command is a handy shortcut for this:
|
|
|
|
|
|
|
|
|
|
$ git clone git@github.com:OpenSlides/OpenSlides.git
|
|
|
|
|
$ cd OpenSlides
|
|
|
|
|
$ git checkout openslides4-dev # needed, until OS4 is released
|
|
|
|
|
$ make run-prod
|
|
|
|
|
|
|
|
|
|
For a development setup, refer to [the development docs](DEVELOPMENT.md)
|
2020-01-05 11:40:21 +01:00
|
|
|
|
|
|
|
|
|
2020-10-05 10:43:43 +02:00
|
|
|
## Productive environment
|
|
|
|
|
|
|
|
|
|
Setup the repository (may be already done)
|
|
|
|
|
|
|
|
|
|
$ git clone git@github.com:OpenSlides/OpenSlides.git
|
|
|
|
|
$ cd OpenSlides
|
|
|
|
|
$ git checkout openslides4-dev
|
|
|
|
|
$ git submodule update --init
|
|
|
|
|
|
|
|
|
|
Prod setup. `./build.sh` may take a while.
|
|
|
|
|
|
|
|
|
|
$ cd docker
|
2021-03-15 14:17:07 +01:00
|
|
|
$ m4 docker-compose.yml.m4 > docker-compose.yml
|
2020-10-05 10:43:43 +02:00
|
|
|
$ ./build.sh
|
|
|
|
|
$ ./setup-prod.sh
|
|
|
|
|
$ docker-compose up
|
|
|
|
|
|
|
|
|
|
Navigate to https://localhost:8000
|
|
|
|
|
|
|
|
|
|
|
2020-01-05 11:40:21 +01:00
|
|
|
## 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.
|
