diff --git a/README.md b/README.md index e08388b45..f5e588ba5 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,48 @@ This is the opensource code repository of the eParticipation website CONSUL, ori Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 september 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6) +## Configuration for development and test environments + +**NOTE**: For more detailed instructions check the [docs](https://github.com/consul/docs/tree/master/en/getting_started/prerequisites) + +Prerequisites: install git, Ruby 2.3.2, bundler gem, and PostgreSQL (>=9.4). + +```bash +git clone https://github.com/consul/consul.git +cd consul +bundle install +cp config/database.yml.example config/database.yml +cp config/secrets.yml.example config/secrets.yml +bin/rake db:create +bin/rake db:migrate +bin/rake db:dev_seed +RAILS_ENV=test rake db:setup +``` + +Run the app locally: + +``` +bin/rails s +``` + +Prerequisites for testing: install PhantomJS >= 2.1.1 + +Run the tests with: + +``` +bin/rspec +``` + +You can use the default admin user from the seeds file: + + **user:** admin@consul.dev + **pass:** 12345678 + +But for some actions like voting, you will need a verified user, the seeds file also includes one: + + **user:** verified@consul.dev + **pass:** 12345678 + ## Documentation Please check the ongoing documentation at https://consul_docs.gitbooks.io/docs/content/ to learn more about how to start your own CONSUL fork, install it, customize it and learn to use it from an administrator/maintainer perspective. You can contribute to it at https://github.com/consul/docs diff --git a/README_ES.md b/README_ES.md index f1a39aae9..86b79e968 100644 --- a/README_ES.md +++ b/README_ES.md @@ -23,6 +23,49 @@ Este es el repositorio de código abierto de la Aplicación de Participación Ci El desarrollo de esta aplicación comenzó el [15 de Julio de 2015](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6) y el código fue puesto en producción el día 7 de Septiembre de 2015 en [decide.madrid.es](https://decide.madrid.es). Desde entonces se le añaden mejoras y funcionalidades constantemente. Las funcionalidades actuales se pueden consultar en [características](http://www.decide.es/es/) o en la [documentación](https://github.com/consul/consul/tree/master/doc) y las siguientes funcionaliades en la lista de [tareas por hacer](https://github.com/consul/consul/issues). Para conocer el estado actual de las próximas caracteristicas, vaya a [Roadmap](https://github.com/consul/consul/projects/6) +## Configuración para desarrollo y tests + +**NOTA**: para unas instrucciones más detalladas consulta la [documentación](https://github.com/consul/docs/tree/master/es/getting_started/prerequisites) + +Prerequisitos: tener instalado git, Ruby 2.3.2, la gema `bundler` y PostgreSQL (9.4 o superior). + +``` + +git clone https://github.com/consul/consul.git +cd consul +bundle install +cp config/database.yml.example config/database.yml +cp config/secrets.yml.example config/secrets.yml +bin/rake db:create +bin/rake db:migrate +bin/rake db:dev_seed +RAILS_ENV=test rake db:setup +``` + +Para ejecutar la aplicación en local: + +``` +bin/rails s +``` + +Prerequisitos para los tests: tener instalado PhantomJS >= 2.1.1 + +Para ejecutar los tests: + +``` +bin/rspec +``` + +Puedes usar el usuario administrador por defecto del fichero seeds: + + **user:** admin@consul.dev + **pass:** 12345678 + +Pero para ciertas acciones, como apoyar, necesitarás un usuario verificado, el fichero seeds proporciona uno: + + **user:** verified@consul.dev + **pass:** 12345678 + ## Documentación Por favor visita la documentación que está siendo completada en https://consul_docs.gitbooks.io/docs/content/ para conocer más sobre este proyecto, como comenzar tu propio fork, instalarlo, customizarlo y usarlo como administrador/mantenedor. Puedes colaborar en ella en https://github.com/consul/docs