consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

adds README_EN.md

Browse Source
This commit is contained in:
Juanjo Bazán
2015-08-07 14:13:39 +02:00
parent 1a97c23b94
commit 9a2d08e3da
1 changed files with 51 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README_EN.md Normal file
View File

@@ -0,0 +1,51 @@
# Ayuntamiento de Madrid (Madrid city's government) eParticipation application
[![Build Status](https://travis-ci.org/AyuntamientoMadrid/participacion.svg?branch=master)](https://travis-ci.org/AyuntamientoMadrid/participacion)
[![Code Climate](https://codeclimate.com/github/AyuntamientoMadrid/participacion/badges/gpa.svg)](https://codeclimate.com/github/AyuntamientoMadrid/participacion)
[![Dependency Status](https://gemnasium.com/AyuntamientoMadrid/participacion.svg)](https://gemnasium.com/AyuntamientoMadrid/participacion)
[![Coverage Status](https://coveralls.io/repos/AyuntamientoMadrid/participacion/badge.svg?branch=master&service=github)](https://coveralls.io/github/AyuntamientoMadrid/participacion?branch=master)
This is the opensource code repository of Madrid City government eParticipation website
## Current state
Development started on [2015 July 15th](https://github.com/AyuntamientoMadrid/participacion/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6)
The project is in its early stages. Features currently present in the code (and their names) are subject to change.
## Tech stack
The application backend is written in the [Ruby language](https://www.ruby-lang.org/) using the [Ruby on Rails](http://rubyonrails.org/) framework.
Frontend tools used include [SCSS](http://sass-lang.com/) over [Foundation](http://foundation.zurb.com/) for the styles.
## Configuration for development and test environments
Prerequisites: install git, Ruby 2.2.2, bundler gem and PostgreSQL.
```
cd participacion
bundle install
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
bundle exec bin/rake db:setup
RAILS_ENV=test bundle exec rake db:setup
```
Run the app locally:
```
bundle exec bin/rails s
```
Run the tests with:
```
bundle exec bin/rspec
```
## Licence
Code published under MIT license (see [MIT-license.md](MIT-license.md))
## Contributions
See [CONTRIBUTING_EN.md](CONTRIBUTING_EN.md)