+# Wolne Lektury
+
+
+
+
+Wolne Lektury is a free internet library maintained by Modern Poland Foundation.
+
+It's a service based on [Django](https://www.djangoproject.com/), using
+[Librarian](https://git.mdrn.pl/librarian.git) to publish books in various formats.
+
+
License
-------
- Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
+ Copyright © 2008-2019 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
For full list of contributors see AUTHORS section at the end.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
+
Dependencies
============
+ * Python 3.5-3.7
* All packages listed in requirements.txt
- * Python libraries from lib directory
- * Django applications from apps directory
+
How to deploy (development version)
=============
-1. Checkout the source code from Github and enter the directory
+1. Checkout the source code from Git and enter the directory
2. Install libraries (we recommend using pip):
- pip install -r requirements.txt
- git submodule update --init
+ pip install -r requirements/requirements.txt
-3. Setup your local configuration based on settings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff.
+3. Setup your local configuration in src/wolnelektury/localsettings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff.
4. Populate database:
- ./manage.py syncdb
./manage.py migrate
5. Run the server
Translation strings are based on gettext and can be found under 'locale' dir.
There are also JavaScript files for jQuery countdown plugin (static/js/jquery.countdown-*.js).
-Full list of used open-source software
-======================================
-
-External
---------
-
-django
---------
- - Source: [djangoproject.com](http://www.djangoproject.com/)
- - Authors: [many authors](http://code.djangoproject.com/browser/django/trunk/AUTHORS)
- - License: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE)
- - Type: framework
-
-django-pagination
------------------
- - Source: [Google Code](http://code.google.com/p/django-pagination/)
- - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
- - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
- - Type: library (django application)
-
-django-rosetta
------------------
- - Source: [Google Code](http://code.google.com/p/django-rosetta/)
- - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
- - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
- - Type: library (django application)
-
-
-Django South
-------------
-- Source: [aercode.org](http://south.aeracode.org/)
-- Authors: Andrew Godwin <andrew@aeracode.org>, Andy McCurdy <sedrik@gmail.com>
-- License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php)
-- Type: library (django application)
-
-lxml
----------
- - Source: [codespeak.net](http://codespeak.net/lxml/index.html#download)
- - Authors: [many authors](http://codespeak.net/lxml/credits.html)
- - License: [BSD License](http://codespeak.net/lxml/index.html#license)
- - Type: library
-
-feedparser
-----------
- - Source: [Google Code](http://code.google.com/p/feedparser/)
- - Authors: Mark Pilgrim <pilgrim@gmail.com>
- - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
- - Type: library
-
-
-Internal (means we hacked on sources of those):
----------
-
-django-chunks
--------------
- - Source: [Google Code](http://code.google.com/p/django-chunks/)
- - Authors: Clint Ecker <clintecker@gmail.com>
- - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
- - Type: library (Django application)
-
-django-newtagging
------------------
- - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
- - Authors: Marek Stępniowski <marek@stepniowski.com>
- - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
- - Type: library (Django aplication)
- - Notes: Aplication based on [django-tagging](http://code.google.com/p/django-tagging/), also [MIT](http://www.opensource.org/licenses/mit-license.php) license.
-
+
+Bundled software
+================
+
+* django-chunks
+ in `src/chunks`
+ based on [django-chunks](http://code.google.com/p/django-chunks/)
+ by Clint Ecker <clintecker@gmail.com>,
+ [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
+* [django-newtagging](http://www.bitbucket.org/zuber/django-newtagging/)
+ in `src/newtagging`
+ by Marek Stępniowski <marek@stepniowski.com>,
+ [MIT License](http://www.opensource.org/licenses/mit-license.php),
+ based on [django-tagging](http://code.google.com/p/django-tagging/), also under [MIT License](http://www.opensource.org/licenses/mit-license.php)
+* [jPlayer](http://jplayer.org/)
+ in `src/catalogue/static/jplayer`
+ by Happyworm,
+ [MIT License](http://opensource.org/licenses/MIT)
+* [Switch template tag](http://djangosnippets.org/snippets/967/)
+ in `src/wolnelektury/templatetags/switch_tag.py`
+ by adurdin
+* Javascript in `src/wolnelektury/static/js/contrib`
+ with relevant attribution and licensing
+
Authors
=======
-
* Marek Stępniowski <marek@stepniowski.com>
* Łukasz Rekucki <lrekucki@gmail.com>
+ * Radek Czajka
+ * Łukasz Anwajler
+ * Marcin Koziej
+ * Aleksander Łukasz
+ * Jan Szejko
+ * Mariusz Machuta
fnp / wolnelektury.git / blobdiff