NameDateSize

..16-Mar-201612 KiB

.gitignore02-Mar-2015377

.travis.yml09-Nov-2015860

AUTHORS01-Dec-2015917

bower.json09-Dec-20151.1 KiB

CHANGELOG09-Dec-201521.1 KiB

gulpfile.js10-Dec-20155 KiB

LICENSE02-Feb-20151.1 KiB

logo/10-Dec-20154 KiB

make/06-Jul-20154 KiB

manage.py25-Aug-2014179

MANIFEST.in09-Dec-2015259

openslides/09-Dec-20154 KiB

package.json10-Dec-2015441

README.rst09-Dec-201510.7 KiB

requirements.txt10-Dec-2015168

requirements_production.txt09-Dec-2015313

setup.cfg17-Jun-2015181

setup.py09-Dec-20151.4 KiB

tests/17-Jun-20154 KiB

README.rst

1============
2 OpenSlides
3============
4
5I. What is OpenSlides?
6======================
7
8OpenSlides is a free web-based presentation and assembly system for
9displaying and controlling of agenda, motions and elections of an assembly.
10See http://openslides.org/ for more information.
11
12
13II. Requirements
14================
15
16OpenSlides runs everywhere where Python is running (for example on
17GNU/Linux, Mac or Windows (XP or newer)). On each client you need only an
18actual webbrowser.
19
20
21III. Installation
22=================
23
24Installation on GNU/Linux or Mac OS X
25-------------------------------------
26
271. Check requirements
28
29   Make sure that you have installed Python Programming Language 3 (>= 3.3)
30   on your system. You will also need the Python development headers.
31
32   For example for Ubuntu run::
33
34       $ sudo apt-get install python3-dev
35
362. Setup a virtual environment with Virtual Python Environment builder
37   (optional)
38
39   You can setup a virtual environment to install OpenSlides as non-root
40   user. Make sure that you have installed Virtual Python Environment
41   builder on your system.
42
43   For example for Ubuntu run::
44
45       $ sudo apt-get install python-virtualenv
46
47   Create your OpenSlides directory, change to it, setup and activate the
48   virtual environment::
49
50       $ mkdir OpenSlides
51       $ cd OpenSlides
52       $ virtualenv -p /usr/bin/python3 .virtualenv
53       $ source .virtualenv/bin/activate
54
553. Install OpenSlides
56
57   You can use the package from the `OpenSlides Website
58   <http://openslides.org/download/>`_. Download latest OpenSlides release
59   as compressed tar archive and run::
60
61       $ pip install openslides-x.x.tar.gz
62
63   OpenSlides will install all required python packages (see
64   requirements_production.txt).
65
66
67Installation on Windows
68-----------------------
69
70*Note: There is a portable version of OpenSlides for Windows which does not
71required any install steps. If there is a reason that you can not use the
72portable version you should observe the following install steps.*
73
741. Check requirements
75
76   Make sure that you have installed Python Programming Language 3 (>= 3.3)
77   and Setuptools on your system.
78
79   a. Download and run the latest `Python 3.4 32-bit MSI installer
80      <https://www.python.org/downloads/windows/>`_. Note
81      that the 32-bit MSI installer is required even on a 64-bit Windows
82      system. If you use the 64-bit MSI installer, step 3 of this
83      instruction will fail unless you installed the package reportlab
84      manually.
85
86   b. Add python directories to PATH (via Control Panel > System >
87      Advanced): ``";C:\\Python34;C:\\Python34\\Scripts"``. Note that the path
88      can differ if you customized the install of Python in the first step.
89
90   c. Download and run (via double click) the last `install script
91      ez_setup.py for Setuptools
92      <https://pypi.python.org/pypi/setuptools/#installation-instructions>`_.
93
942. Setup a virtual environment with Virtual Python Environment builder
95   (optional)
96
97   You can setup a virtual environment to install OpenSlides as non-root
98   user. Make sure that you have installed Virtual Python Environment
99   builder on your system.
100
101   To install Virtual Python Environment builder, open command line (cmd)
102   and run::
103
104       > easy_install https://pypi.python.org/packages/source/v/virtualenv/virtualenv-12.0.5.tar.gz
105
106   Create your OpenSlides directory, change to it, setup and activate the
107   virtual environment::
108
109       > md OpenSlides
110       > cd OpenSlides
111       > virtualenv .virtualenv
112       > .virtualenv\Scripts\activate
113
1143. Install OpenSlides
115
116   You can use the package from the `OpenSlides Website
117   <http://openslides.org/download/>`_. Download latest OpenSlides release
118   as compressed tar archive and run::
119
120       > easy_install openslides-x.x.tar.gz
121
122   OpenSlides will install all required python packages (see
123   requirements_production.txt).
124
125
126IV. Start
127=========
128
129To start OpenSlides simply run on command line::
130
131    openslides
132
133If you run this command the first time, a new database and the admin account
134(Username: `admin`, Password: `admin`) will be created. Please change the password
135after first login!
136
137OpenSlides will start using the integrated Tornado webserver. It will also
138try to open the webinterface in your default webbrowser. The server will
139try to listen on the local ip address on port 8000. That means that the server
140will be available to everyone on your local network (at least for commonly used
141network configurations).
142
143If you use a virtual environment (see install instructions, step 2), do not
144forget to activate the environment before restart after you have closed the
145terminal.
146
147For Unix and Mac OS X run::
148
149    $ source .virtualenv/bin/activate
150
151For Windows run::
152
153    > .virtualenv\Scripts\activate
154
155To get help on the command line options run::
156
157    openslides --help
158
159
160V. Development
161==============
162
163If you want to join us developing OpenSlides, have a look at `GitHub
164<https://github.com/OpenSlides/OpenSlides/>`_ or write an email to our
165`mailing list <http://openslides.org/contact/>`_.
166
167
168Installation and start of the development version
169-------------------------------------------------
170
1711. Check requirements
172
173   You need to have `Python 3 (>=3.3) <https://www.python.org/>`_, `Node.js
174   (>=0.10) <https://nodejs.org/>`_ and `Git <http://git-scm.com/>`_
175   installed. See also step 1 in the correspondent instruction in section
176   III.
177
1782. Get OpenSlides source code
179
180   Clone current master version from `OpenSlides' GitHub repository
181   <https://github.com/OpenSlides/OpenSlides/>`_::
182
183       cd ...  # Go to a nice place in your filesystem.
184       git clone https://github.com/OpenSlides/OpenSlides.git
185       cd OpenSlides
186
1873. Setup and activate a virtual environment with Virtual Python Environment
188   builder (optional)
189
190   Follow step 2 in the correspondent instruction in section III.
191
1924. Install all required Python packages::
193
194       $ pip install -r requirements.txt
195
1965. Install all npm and bower packages
197
198   For Unix and Mac OS X run::
199
200       $ npm install
201       $ node_modules/.bin/bower install
202
203   For Windows run::
204
205       > npm install
206       > node_modules\.bin\bower install
207
2086. Concat and copy all third party JavaScript and Cascading Style Sheets
209   libraries
210
211   For Unix and Mac OS X run::
212
213       $ node_modules/.bin/gulp
214
215   For Windows run::
216
217       > node_modules\.bin\gulp
218
2197. Start OpenSlides
220
221   Use the command-line interface::
222
223       python manage.py start
224
225   This will create a new development directoy with settings.py and database.
226
227   To get help on the command-line options run::
228
229       python manage.py --help
230
231
232Coding Style
233------------
234
235You can find some information on the coding style in the `OpenSlides wiki
236<https://github.com/OpenSlides/OpenSlides/wiki/De%3ACode-Richtlinien-f%C3%BCr-Openslides>`_.
237
238
239VI. Used software
240=================
241
242OpenSlides uses the following projects or parts of them:
243
244* `backports-abc <https://github.com/cython/backports_abc>`_,
245  License: Python Software Foundation License
246
247* `Beautiful Soup <http://www.crummy.com/software/BeautifulSoup/>`_,
248  License: MIT
249
250* `Django <https://www.djangoproject.com>`_, License: BSD
251
252* `Django haystack <http://haystacksearch.org>`_, License: BSD
253
254* `Django REST framework <http://www.django-rest-framework.org>`_, License: BSD
255
256* `html5-lib <https://github.com/html5lib/html5lib-python>`_, License: MIT
257
258* `jsonfield <https://github.com/bradjasper/django-jsonfield/>`_, License: MIT
259
260* `natsort <https://github.com/SethMMorton/natsort/>`_, License: MIT
261
262* `ReportLab <http://www.reportlab.com/software/opensource/rl-toolkit/>`_,
263  License: BSD
264
265* `roman <https://pypi.python.org/pypi/roman>`_, License: Python 2.1.1
266
267* `setuptools <https://pypi.python.org/pypi/setuptools>`_,
268  License: Python Software Foundation License
269
270* `sockjs-tornado <https://github.com/mrjoes/sockjs-tornado>`_,
271  License: MIT
272
273* `Tornado <http://www.tornadoweb.org/en/stable/>`_, License: Apache
274  License v2.0
275
276* Several JavaScript packages (see bower.json)
277
278  * `angular <https://angularjs.org>`_, License: MIT
279  * `angular-animate <https://github.com/angular/bower-angular-animate>`_, License: MIT
280  * `angular-bootstrap <https://angular-ui.github.io/bootstrap>`_, License: MIT
281  * `angular-ckeditor <https://github.com/lemonde/angular-ckeditor>`_, License: MIT
282  * `angular-csv-import <https://github.com/cybadave/angular-csv-import>`_, License: MIT
283  * `angular-formly <http://angular-formly.com/>`_, License: MIT
284  * `angular-formly-templates-bootstrap <http://angular-formly.com/>`_, License: MIT
285  * `angular-gettext <https://angular-gettext.rocketeer.be/>`_, License: MIT
286  * `angular-loading-bar <https://chieffancypants.github.io/angular-loading-bar/>`_, License: MIT
287  * `angular-messages <https://github.com/angular/bower-angular-messages>`_, License: MIT
288  * `angular-sanitize <https://github.com/angular/bower-angular-sanitize>`_, License: MIT
289  * `angular-scroll-glue <https://github.com/Luegg/angularjs-scroll-glue>`_, License: MIT
290  * `angular-ui-router <http://angular-ui.github.io/ui-router>`_, License: MIT
291  * `angular-ui-select <https://github.com/angular-ui/ui-select>`_, License: MIT
292  * `angular-ui-switch <https://github.com/xpepermint/angular-ui-switch>`_, License: MIT
293  * `angular-ui-tree <https://github.com/JimLiu/angular-ui-tree>`_, License: MIT
294  * `api-check <https://github.com/kentcdodds/apiCheck.js>`_, License: MIT
295  * `bootbox <http://bootboxjs.com/>`_, License: MIT
296  * `bootstrap <http://getbootstrap.com>`_, License: MIT
297  * `bootstrap-css-only <http://getbootstrap.com>`_, License: MIT
298  * `ckeditor <http://ckeditor.com>`_, License: For licensing, see LICENSE.md or http://ckeditor.com/license.
299  * `font-awesome-bower <https://github.com/interval-braining/font-awesome-bower>`_, License: MIT
300  * `jquery <https://jquery.com>`_, License: MIT
301  * `jquery.cookie <https://plugins.jquery.com/cookie>`_, License: MIT
302  * `js-data <http://www.js-data.io>`_, License: MIT
303  * `js-data-angular <http://www.js-data.io/docs/js-data-angular>`_, License: MIT
304  * `js-data-http <http://www.js-data.io/docs/dshttpadapter>`_, License: MIT
305  * `lodash <https://lodash.com/>`_, License: MIT
306  * `ng-dialog <https://github.com/likeastore/ngDialog>`_, License: MIT
307  * `ng-file-upload <https://github.com/danialfarid/ng-file-upload>`_, License: MIT
308  * `ngBootbox <https://github.com/eriktufvesson/ngBootbox>`_, License: MIT
309  * `open-sans-fontface <https://github.com/FontFaceKit/open-sans>`_, License: Apache License version 2.0
310  * `roboto-condensed <https://github.com/davidcunningham/roboto-condensed>`_, License: Apache-2.0
311  * `sockjs <https://github.com/sockjs/sockjs-client>`_, License: MIT
312
313
314VII. License and authors
315========================
316
317OpenSlides is Free/Libre Open Source Software (FLOSS), and distributed under
318the MIT License, see LICENSE file. The authors of OpenSlides are mentioned
319in the AUTHORS file.
320