45c7e4e2346f8248a97c749698290ac8ceee9c1e
[wolnelektury.git] / README.md
1 License
2 -------
3
4   ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
5     
6     Copyright © 2008-2019 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
7     
8     For full list of contributors see AUTHORS section at the end. 
9
10     This program is free software: you can redistribute it and/or modify
11     it under the terms of the GNU Affero General Public License as published by
12     the Free Software Foundation, either version 3 of the License, or
13     (at your option) any later version.
14
15     This program is distributed in the hope that it will be useful,
16     but WITHOUT ANY WARRANTY; without even the implied warranty of
17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18     GNU Affero General Public License for more details.
19
20     You should have received a copy of the GNU Affero General Public License
21     along with this program.  If not, see <http://www.gnu.org/licenses/>.
22     
23 Dependencies
24 ============
25
26  * Python 3.4+
27  * All packages listed in requirements.txt
28  * Sass>=3.2
29
30 How to deploy (development version)
31 =============
32
33 1. Checkout the source code from Git and enter the directory
34 2. Install libraries (we recommend using pip):
35
36     pip install -r requirements/requirements.txt
37
38 3. Setup your local configuration in src/wolnelektury/localsettings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff.
39 4. Populate database:
40     
41     ./manage.py migrate
42
43 5. Run the server
44
45    ./manage.py runserver
46
47     
48 6. Import some books which are available on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/
49    If you use Bitbucket, you also need Mercurial to fetch books (you can install it using: pip install mercurial).
50    After downloading books, log into administration, go to Books and choose 'Browse' to select book file,
51    then fire 'Import book' to upload it. Some books have invalid XML, so you can get an error
52    (just ignore it and look for other books).
53    
54 7. We provide localization of the software in following languages: Polish, Russian, German, English, Spanish, French and Lithuanian.
55    Translation strings are based on gettext and can be found under 'locale' dir.
56    There are also JavaScript files for jQuery countdown plugin (static/js/jquery.countdown-*.js).
57
58 Bundled software
59 ================
60
61 * django-chunks
62   in `apps/chunks`
63   based on [django-chunks](http://code.google.com/p/django-chunks/)
64   by Clint Ecker <clintecker@gmail.com>,
65   [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
66 * [django-newtagging](http://www.bitbucket.org/zuber/django-newtagging/)
67   in `apps/newtagging`
68   by Marek Stępniowski <marek@stepniowski.com>,
69   [MIT License](http://www.opensource.org/licenses/mit-license.php),
70   based on [django-tagging](http://code.google.com/p/django-tagging/), also under [MIT License](http://www.opensource.org/licenses/mit-license.php)
71 * [jPlayer](http://jplayer.org/)
72   in `apps/catalogue/static/jplayer`
73   by Happyworm,
74   [MIT License](http://opensource.org/licenses/MIT)
75 * [Switch template tag](http://djangosnippets.org/snippets/967/)
76   in `apps/wolnelektury_core/templatetags/switch_tag.py`
77   by adurdin
78 * [Cropping engine for sorl-thumbnail](http://timmyomahony.com/blog/custom-cropping-engine-sorl-thumbnail/)
79   in `apps/picture/engine.py`
80   by Timmy O'Mahony
81 * Javascript in `apps/wolnelektury_core/static/js/contrib`
82   with relevant attribution and licensing
83   
84
85
86 Authors
87 =======
88  * Marek Stępniowski  <marek@stepniowski.com>
89  * Łukasz Rekucki <lrekucki@gmail.com>
90  * Radek Czajka
91  * Łukasz Anwajler
92  * Marcin Koziej
93  * Aleksander Łukasz
94  * Jan Szejko
95  * Mariusz Machuta