README.rst

   1 e-cidadania
   2 ===========
   3
   4 Current version: 0.1.9 alpha
   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 * Set *src/e_cidadania/settings/__init__.py* DEBUG to False
  31 * Generate the database with::
  32
  33     python manage.py syncdb
  34
  35 * Make all the south migrations::
  36
  37     pytohn manage.py migrate
  38
  39 * Copy all the static files::
  40
  41     python manage.py collectstatic
  42
  43 * Run the development server
  44
  45     python manage.py runserver
  46
  47 Demonstration
  48 -------------
  49
  50 There is a demo running in the website http://demo.ecidadania.org.
  51
  52 Development
  53 -----------
  54
  55 **We need developers! If you want to join us, send an email to info@ecidadania.org**
  56
  57 Development and bugtracking is done through `code.ecidadania.org <http://code.ecidadania.org>`_
  58
  59 Getting help
  60 ------------
  61
  62  * `Documentation <http://code.ecidadania.org/wiki/Documentation>`_ e-cidadania documentation.
  63  * `Mailing lists <http://code.ecidadania.org/wiki/MailingLists>`_ global and local.
  64  * `Social networks <http://code.ecidadania.org/wiki/SocialNetworks>`_ where e-cidadania present.
  65  * `Website <http://ecidadania.org>`_ e-cidadania official website.
  66  * `IRC channels <http://webchat.freenode.net>`_ #ecidadania-dev and #ecidadania for e-cidadania.
  67
  68 Useful information
  69 ------------------
  70
  71  * `Design concepts <http://code.ecidadania.org/wiki/DesignConcepts>`_ design concepts, this are the guides to follow when developing.
  72  * `Releases <http://code.ecidadania.org/wiki/Releases>`_ version roadmap. This is where we stablish the features, release dates and other things of every version.
  73
  74 Collaborate
  75 -----------
  76
  77 * **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". Please check the `How To Contribute <http://code.ecidadania.org/wiki/HowToContribute>`_ page.
  78
  79 * **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.
  80
  81 * **Translating**  You can contribute translating e-cidadania from its page on `Transifex <http://www.transifex.net/projects/p/ecidadania/>`_. If you need a language that is not available, ask for it from Transifex and we will create it ASAP.
  82
  83 * **Bug reporting** You can report the bugs you find in the application in this trac: http://code.ecidadania.org