Provide a Freedom of Information request system for your jurisdiction
Ruby HTML JavaScript CSS Shell Perl Other
Permalink
Failed to load latest commit information.
.tx Switch .tx/config to refer to transifex.com instead of transifex.net Nov 7, 2013
app Merge branch '2097-dont-include-mail-in-bounce' into develop Aug 19, 2016
commonlib @ 977b8d8 Update commonlib to get improved make_clickable. Aug 12, 2016
config Use version of geoip-database package that keeps database updated Aug 17, 2016
db Remove Comment#comment_type Jul 25, 2016
doc Use version of geoip-database package that keeps database updated Aug 17, 2016
lib Update list of alaveteli installs. Aug 1, 2016
locale Update translations Jul 19, 2016
public Add MailServerLogsController#index May 6, 2016
script Tidy up job status output so it is only printed when it has changed. … Jul 21, 2016
spec Merge branch '2097-dont-include-mail-in-bounce' into develop Aug 19, 2016
tmp tmp directory should be available Apr 2, 2012
vendor Move acts_as_xapian out of vendor/plugins Nov 29, 2013
.codeclimate.yml Don't analyze JavaScript code quality May 27, 2015
.gitignore Ignore any live ruby version files. Apr 27, 2015
.gitmodules Remove softlink to vendor/rails-locales and reference to it. Apr 25, 2013
.hound.yml Add default hound config Nov 17, 2015
.pryrc Switch from pry-nav to pry-debugger Apr 28, 2016
.rspec Use Spork instead of writing our own Feb 19, 2013
.ruby-style.yml Allow multi-line {} blocks for rspec Jul 25, 2016
.ruby-version.example Ignore any live ruby version files. Apr 27, 2015
.travis.yml Add later versions of ruby to testing matrix. Jan 14, 2016
Capfile Turn on precompilation of assets in Capistrano. Jan 24, 2014
Gemfile Merge branch 'hotfix/0.25.0.3' into develop Aug 12, 2016
Gemfile.lock Merge branch 'hotfix/0.25.0.3' into develop Aug 12, 2016
LICENSE.txt Move acts_as_xapian out of vendor/plugins Nov 29, 2013
README.md Add shoutout to Browserstack in README Aug 4, 2016
Rakefile 2-space Rakefile Jul 24, 2015
Vagrantfile Add jessie support Mar 7, 2016
config.ru Run the Rails 3 generator Dec 11, 2012

README.md

Welcome to Alaveteli!

Build Status Dependency Status Coverage Status Code Climate Installability: Gold

This is an open source project to create a standard, internationalised platform for making Freedom of Information (FOI) requests in different countries around the world. The software started off life as WhatDoTheyKnow, a website produced by mySociety for making FOI requests in the UK.

We hope that by joining forces between teams across the world, we can all work together on producing the best possible software, and help move towards a world where governments approach transparency as the norm, rather than the exception.

Please join our mailing list at https://groups.google.com/group/alaveteli-dev and introduce yourself, or drop a line to hello@alaveteli.org to let us know that you're using Alaveteli.

There's lots of useful information and documentation (including a blog) on the project website. There's background information and notes on our wiki, and upgrade notes in the doc/ folder

Installing

We've been working hard to make Alaveteli easy to install and re-use anywhere. Please see the project website for instructions on installing Alaveteli.

Compatibility

Every Alaveteli commit is tested by Travis on the following Ruby platforms

  • ruby-1.9.3
  • ruby-2.0.0
  • ruby-2.1.5
  • ruby-2.3.0

If you use a ruby version management tool (such as RVM or .rbenv) and want to use the default development version used by the alaveteli team (currently 2.0.0), you can create a .ruby-version symlink with a target of .ruby-version.example to switch to that automatically in the project directory.

How to contribute

If you find what looks like a bug:

  • Check the GitHub issue tracker to see if anyone else has reported issue.
  • If you don't see anything, create an issue with information on how to reproduce it.

If you want to contribute an enhancement or a fix:

  • Fork the project on GitHub.
  • Make a topic branch from the develop branch.
  • Make your changes with tests.
  • Commit the changes without making changes to any files that aren't related to your enhancement or fix.
  • Send a pull request against the develop branch.

Looking for the latest stable release? It's on the master branch.

We have some more notes for developers on the project site.

Examples

See more at alaveteli.org.

Acknowledgements

Thanks to Browserstack who let us use their web-based cross-browser testing tools for this project.