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