README.rst

   1 e-cidadania
   2 ===========
   3
   4 Current version: 0.1.8 beta
   5
   6 e-cidadania is a project to develop an open source application for citizen
   7 participation, which can be used for debates, proposals, trusted voting,
   8 usable by associations, companies and administrations.
   9
  10 The e-cidadania objective is to provide a way to make a full participation
  11 process on internet, or even use it as a complement to in person participative
  12 processes.
  13
  14 Installation
  15 ------------
  16
  17 Since e-cidadania 0.1.5 we include an automated buildout system. If you want to
  18 install it to do testing or development you should see
  19 `these instructions <https://github.com/cidadania/e-cidadania/blob/gsoc2012/docs/en/dev/environment.rst>`_
  20
  21 If you don't want to create an isolated development environment:
  22
  23 * Download the source code from git, or from the official webpage.
  24 * You need to install the python packages specified in requirements.txt for
  25   e-cidadania, you can do it with pip::
  26
  27     sudo pip install -r requirements.txt
  28
  29 * Configure *src/e_cidadania/settings/production.py to you desire.
  30 * Generate the database with::
  31
  32     python manage.py syncdb
  33
  34 * Copy all the static files::
  35
  36     python manage.py collectstatic
  37
  38 * Run the development server
  39
  40     python manage.py runserver
  41
  42 Demonstration
  43 -------------
  44
  45 There is a demo running in the website http://demo.ecidadania.org.
  46
  47 Development
  48 -----------
  49
  50 **We need developers! If you want to join us, send an email to oscar.carballal AT cidadania DOT coop**
  51
  52 Development and bugtracking is done through `code.ecidadania.org <http://code.ecidadania.org>`_
  53
  54 Getting help
  55 ------------
  56
  57  * `Documentation <http://code.ecidadania.org/wiki/Documentation>`_ e-cidadania documentation.
  58  * `Mailing lists <http://code.ecidadania.org/wiki/MailingLists>`_ global and local.
  59  * `Social networks <http://code.ecidadania.org/wiki/SocialNetworks>`_ where e-cidadania present.
  60  * `Website <http://ecidadania.org>`_ e-cidadania official website.
  61  * `IRC channels <http://webchat.freenode.net>`_ #ecidadania-dev and #ecidadania for e-cidadania.
  62
  63 Useful information
  64 ------------------
  65
  66  * `Design concepts <http://code.ecidadania.org/wiki/DesignConcepts>`_ design concepts, this are the guides to follow when developing.
  67  * `Releases <http://code.ecidadania.org/wiki/Releases>`_ version roadmap. This is where we stablish the features, release dates and other things of every version.
  68
  69 Collaborate
  70 -----------
  71
  72 * **Developing** You can take the last code from the repository and experiment with it. When you're done, you can send us a "Merge request".
  73
  74 * **Documenting** Right now the documentation is a bit insufficient. If you want to document e-cidadania, feel free to do it. We use Sphinx (1.1.3) to generate the documents.
  75
  76 * **Translating** e-cidadania achieves to be international. If you want to translate it to your language just follow the steps in the documentation an send your catalog to us, we will include it ASAP.
  77
  78 * **Bug reporting** You can report the bugs you find in the application in this trac: http://code.ecidadania.org