Skip to content
Presentation and assembly system http://openslides.org
Python JavaScript HTML CSS Smarty
Find file

README.rst

OpenSlides

I. What is OpenSlides?

OpenSlides is a free web-based presentation and assembly system for displaying and controlling of agenda, motions and elections of an assembly. See http://openslides.org/ for more information.

II. Requirements

OpenSlides runs everywhere where Python is running (for example on GNU/Linux, Mac or Windows (XP or newer)). On each client you need only a current version of a webbrowser.

III. Installation

Installation on GNU/Linux or Mac OS X

  1. Check requirements

    Make sure that you have installed Python Programming Language 3 (>= 3.4) on your system. You will also need the Python development headers.

    For example for Ubuntu run:

    $ sudo apt-get install python3-dev
    
  2. Setup a virtual Python environment using the virtual environment (venv) package for Python (optional)

    You can setup a virtual Python environment to install OpenSlides as non-root user.

    Note: For Ubuntu 14.04 you have to install the pyvenv binary package. Run:

    $ sudo apt-get install python3.4-venv
    

    Create your OpenSlides directory, change to it, setup and activate the virtual environment:

    $ mkdir OpenSlides
    $ cd OpenSlides
    $ python3 -m venv .virtualenv
    $ source .virtualenv/bin/activate
    
  3. Install OpenSlides

    You can use the package from the OpenSlides Website. Download latest OpenSlides release as compressed tar archive and run:

    $ pip install openslides-x.x.tar.gz
    

    OpenSlides will install all required Python packages (see requirements_production.txt).

Installation on Windows

Note: There is a portable version of OpenSlides for Windows which does not require any install steps. If there is a reason that you can not use the portable version you should observe the following install steps.

  1. Check requirements

    Make sure that you have installed Python Programming Language 3 (>= 3.4) and Setuptools on your system.

    1. Download and run the latest Python 3.4 32-bit MSI installer. Note that the 32-bit MSI installer is required even on a 64-bit Windows system. If you use the 64-bit MSI installer, step 3 of this instruction will fail unless you installed the package Reportlab manually.
    2. Add python directories to PATH (via Control Panel > System > Advanced): ";C:\\Python34;C:\\Python34\\Scripts". Note that the path can differ if you customized the install of Python in the first step.
    3. Download and run (via double click) the last install script ez_setup.py for Setuptools.
  2. Setup a virtual Python environment using the virtual environment (venv) package for Python (optional)

    You can setup a virtual Python environment to install OpenSlides as non-root user.

    Create your OpenSlides directory, change to it, setup and activate the virtual environment:

    > md OpenSlides
    > cd OpenSlides
    > python -m venv .virtualenv
    > .virtualenv\Scripts\activate.bat
    
  3. Install OpenSlides

    You can use the package from the OpenSlides Website. Download latest OpenSlides release as compressed tar archive and run:

    > pip install openslides-x.x.tar.gz
    

    OpenSlides will install all required Python packages (see requirements_production.txt).

IV. Start

To start OpenSlides simply run on command line:

openslides

If you run this command the first time, a new database and the admin account (Username: admin, Password: admin) will be created. Please change the password after first login!

OpenSlides will start using the integrated Tornado webserver. It will also try to open the webinterface in your default webbrowser. The server will try to listen on the local ip address on port 8000. That means that the server will be available to everyone on your local network (at least for commonly used network configurations).

If you use a virtual environment (see install instructions, step 2), do not forget to activate the environment before restart after you have closed the terminal.

For Unix and Mac OS X run:

$ source .virtualenv/bin/activate

For Windows run:

> .virtualenv\Scripts\activate

To get help on the command line options run:

openslides --help

V. Development

If you want to join us developing OpenSlides, have a look at GitHub or write an email to our mailing list.

Installation and start of the development version

  1. Check requirements

    You need to have Python 3 (>=3.4), Node.js (>=0.10) and Git installed. See also step 1 in the correspondent instruction in section III.

  2. Get OpenSlides source code

    Clone current master version from OpenSlides' GitHub repository:

    cd ...  # Go to a nice place in your filesystem.
    git clone https://github.com/OpenSlides/OpenSlides.git
    cd OpenSlides
    
  3. Setup a virtual Python environment using the virtual environment (venv) package for Python (optional)

    See step 2 in the correspondent instruction in section III.

  4. Install all required Python packages:

    $ pip install -r requirements.txt
    
  5. Install all npm and bower packages

    For Unix and Mac OS X run:

    $ npm install
    $ node_modules/.bin/bower install
    

    For Windows run:

    > npm install
    > node_modules\.bin\bower install
    
  6. Concat and copy all third party JavaScript and Cascading Style Sheets libraries

    For Unix and Mac OS X run:

    $ node_modules/.bin/gulp
    

    For Windows run:

    > node_modules\.bin\gulp
    
  7. Start OpenSlides

    Use the command-line interface:

    python manage.py start
    

    This will create a new development directoy with settings.py and database.

    To get help on the command-line options run:

    python manage.py --help
    

    Later you might want to start the server with the following command to avoid opening new browser windows:

    python manage.py runserver
    

VI. Used software

OpenSlides uses the following projects or parts of them:

VII. 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.

Something went wrong with that request. Please try again.