Skip to content
Provide a Freedom of Information request system for your jurisdiction http://alaveteli.org
Ruby HTML JavaScript CSS Shell Perl
Find file
Failed to load latest commit information.
.tx Switch .tx/config to refer to transifex.com instead of transifex.net
app Avoid showing missing images on the admin/stats page
commonlib @ 887c82a Get htmlentities from Gemfile, not commonlib.
config Add EXTERNAL_REVIEWERS config
db Add last_public_response_at to InfoRequest
doc Update changelog
lib Supply a config array and loop over it to plot multiple datasets
locale Latest translations from Transifex.
public Delete .cvsignore
script Make the graph generation scripts call the rake tasks
spec Supply a config array and loop over it to plot multiple datasets
tmp tmp directory should be available
vendor Move acts_as_xapian out of vendor/plugins
.codeclimate.yml Don't analyze JavaScript code quality
.gitignore Ignore any live ruby version files.
.gitmodules Remove softlink to vendor/rails-locales and reference to it.
.hound.yml Add default hound config
.pryrc Add the pry-nav gem to enable debugging steps with pry
.rspec Use Spork instead of writing our own
.ruby-style.yml Disable all style checks by default
.ruby-version.example Ignore any live ruby version files.
.travis.yml Add later versions of ruby to testing matrix.
Capfile Turn on precompilation of assets in Capistrano.
Gemfile Move graph generation to rake file
Gemfile.lock Move graph generation to rake file
LICENSE.txt Move acts_as_xapian out of vendor/plugins
README.md Add docs on new ruby versions.
Rakefile 2-space Rakefile
Vagrantfile Add next steps advice to the end of the vagrant install output
config.ru Run the Rails 3 generator

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.

Something went wrong with that request. Please try again.