README.rst

   1 e-cidadania
   2 ===========
   3
   4 Current version: 0.1.5 RC1
   5
   6 e-cidadania is a project to develop an open source application for citizen participation, usable by associations, companies and administrations.
   7
   8 The e-cidadania objective is to maintain the platform as easy as possible while improving in the user interface to be easier to use as possible.
   9
  10 Installation
  11 ------------
  12
  13 Since e-cidadania 0.1.5 RC1 e-cidadania includes an automated buildout system.
  14 If you want to install it to do testing or development you should see
  15 `these instructions <https://github.com/cidadania/e-cidadania/blob/gsoc2012/docs/en/dev/environment.rst>`_
  16
  17 If you don't want to create an isolated development environment,
  18 * Download the source code from git, or from the official webpage.
  19 * You need to install the python packages specified in requirements.txt for e-cidadania, you can do it with pip::
  20
  21     sudo pip install -r requirements.txt
  22
  23 * Configure setting.py to you desire.
  24 * Generate the database with::
  25
  26     python manage.py syncdb
  27
  28 * Copy all the static files::
  29
  30     python manage.py collectstatic
  31
  32 * Run the development server
  33
  34     python manage.py runserver
  35
  36 Demonstration
  37 -------------
  38
  39 There is a demo running in the website http://demo.ecidadania.org.
  40
  41 Development
  42 -----------
  43
  44 **We need developers! If you want to join us, send an email to oscar.carballal AT cidadania DOT coop**
  45
  46 Development and bugtracking is done through `code.ecidadania.org <http://code.ecidadania.org>`_
  47
  48 Getting help
  49 ------------
  50
  51  * `Documentation <http://code.ecidadania.org/wiki/Documentation>`_ e-cidadania documentation.
  52  * `Mailing lists <http://code.ecidadania.org/wiki/MailingLists>`_ global and local.
  53  * `Social networks <http://code.ecidadania.org/wiki/SocialNetworks>`_ where e-cidadania present.
  54  * `Website <http://ecidadania.org>`_ e-cidadania official website.
  55  * `IRC channels <http://webchat.freenode.net>`_ #ecidadania-dev and #ecidadania for e-cidadania.
  56
  57 Useful information
  58 ------------------
  59
  60  * `Design concepts <http://code.ecidadania.org/wiki/DesignConcepts>`_ design concepts, this are the guides to follow when developing.
  61  * `Releases <http://code.ecidadania.org/wiki/Releases>`_ version roadmap. This is where we stablish the features, release dates and other things of every version.
  62
  63 Collaborate
  64 -----------
  65
  66 * **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".
  67
  68 * **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.
  69
  70 * **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.
  71
  72 * **Bug reporting** You can report the bugs you find in the application in this trac: http://code.ecidadania.org