README.md

   1 License
   2 -------
   3
   4   ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
   5
   6     Copyright © 2008,2009,2010 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  * All packages listed in requirements.txt
  27  * Python libraries from lib directory
  28  * Django applications from apps directory
  29
  30 How to deploy (development version)
  31 =============
  32
  33 1. Checkout the source code from Github and enter the directory
  34 2. Install libraries (we recommend using pip):
  35
  36     pip install -r requirements.txt
  37     git submodule update --init
  38
  39 3. Setup your local configuration based on settings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff.
  40 4. Populate database:
  41
  42     ./manage.py syncdb
  43     ./manage.py migrate
  44
  45 5. Run the server
  46
  47    ./manage.py runserver
  48
  49
  50 6. Import some books which are available on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/
  51    If you use Bitbucket, you also need Mercurial to fetch books (you can install it using: pip install mercurial).
  52    After downloading books, log into administration, go to Books and choose 'Browse' to select book file,
  53    then fire 'Import book' to upload it. Some books have invalid XML, so you can get an error
  54    (just ignore it and look for other books).
  55
  56 7. We provide localization of the software in following languages: Polish, Russian, German, English, Spanish, French and Lithuanian.
  57    Translation strings are based on gettext and can be found under 'locale' dir.
  58    There are also JavaScript files for jQuery countdown plugin (static/js/jquery.countdown-*.js).
  59
  60 Full list of used open-source software
  61 ======================================
  62
  63 External
  64 --------
  65
  66 django
  67 --------
  68  - Source: [djangoproject.com](http://www.djangoproject.com/)
  69  - Authors: [many authors](http://code.djangoproject.com/browser/django/trunk/AUTHORS)
  70  - License: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE)
  71  - Type: framework
  72
  73 django-pagination
  74 -----------------
  75  - Source: [Google Code](http://code.google.com/p/django-pagination/)
  76  - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
  77  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
  78  - Type: library (django application)
  79
  80 django-rosetta
  81 -----------------
  82  - Source: [Google Code](http://code.google.com/p/django-rosetta/)
  83  - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
  84  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
  85  - Type: library (django application)
  86
  87
  88 Django South
  89 ------------
  90 - Source: [aercode.org](http://south.aeracode.org/)
  91 - Authors: Andrew Godwin <andrew@aeracode.org>, Andy McCurdy <sedrik@gmail.com>
  92 - License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php)
  93 - Type: library (django application)
  94
  95 lxml
  96 ---------
  97  - Source: [codespeak.net](http://codespeak.net/lxml/index.html#download)
  98  - Authors: [many authors](http://codespeak.net/lxml/credits.html)
  99  - License: [BSD License](http://codespeak.net/lxml/index.html#license)
 100  - Type: library
 101
 102 feedparser
 103 ----------
 104  - Source: [Google Code](http://code.google.com/p/feedparser/)
 105  - Authors: Mark Pilgrim <pilgrim@gmail.com>
 106  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
 107  - Type: library
 108
 109
 110 Internal (means we hacked on sources of those):
 111 ---------
 112
 113 django-chunks
 114 -------------
 115  - Source: [Google Code](http://code.google.com/p/django-chunks/)
 116  - Authors: Clint Ecker <clintecker@gmail.com>
 117  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 118  - Type: library (Django application)
 119
 120 django-newtagging
 121 -----------------
 122  - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
 123  - Authors: Marek Stępniowski <marek@stepniowski.com>
 124  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
 125  - Type: library (Django aplication)
 126  - Notes: Aplication based on  [django-tagging](http://code.google.com/p/django-tagging/), also [MIT](http://www.opensource.org/licenses/mit-license.php) license.
 127
 128
 129 Authors
 130 =======
 131
 132  * Marek Stępniowski  <marek@stepniowski.com>
 133  * Łukasz Rekucki <lrekucki@gmail.com>