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  * Python 2.7
  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 Github and enter the directory
  34 2. Install libraries (we recommend using pip):
  35
  36     pip install -r requirements/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 migrate
  43
  44 5. Run the server
  45
  46    ./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 Bundled software
  60 ================
  61
  62 * django-chunks
  63   in `apps/chunks`
  64   based on [django-chunks](http://code.google.com/p/django-chunks/)
  65   by Clint Ecker <clintecker@gmail.com>,
  66   [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
  67 * [django-newtagging](http://www.bitbucket.org/zuber/django-newtagging/)
  68   in `apps/newtagging`
  69   by Marek Stępniowski <marek@stepniowski.com>,
  70   [MIT License](http://www.opensource.org/licenses/mit-license.php),
  71   based on [django-tagging](http://code.google.com/p/django-tagging/), also under [MIT License](http://www.opensource.org/licenses/mit-license.php)
  72 * [jPlayer](http://jplayer.org/)
  73   in `apps/catalogue/static/jplayer`
  74   by Happyworm,
  75   [MIT License](http://opensource.org/licenses/MIT)
  76 * [Switch template tag](http://djangosnippets.org/snippets/967/)
  77   in `apps/wolnelektury_core/templatetags/switch_tag.py`
  78   by adurdin
  79 * [Cropping engine for sorl-thumbnail](http://timmyomahony.com/blog/custom-cropping-engine-sorl-thumbnail/)
  80   in `apps/picture/engine.py`
  81   by Timmy O'Mahony
  82 * Javascript in `apps/wolnelektury_core/static/js/contrib`
  83   with relevant attribution and licensing
  84
  85
  86
  87 Authors
  88 =======
  89  * Marek Stępniowski  <marek@stepniowski.com>
  90  * Łukasz Rekucki <lrekucki@gmail.com>