diff options
| author | Luc Donnet | 2013-05-27 17:56:27 +0200 |
|---|---|---|
| committer | Luc Donnet | 2013-05-27 17:56:27 +0200 |
| commit | bab85e7e646012b2cffabea5ff7987ecde6c0a25 (patch) | |
| tree | 926f33a1585a7fb9bbc1ab4eba37a4fc384cc743 /README.md | |
| parent | 04665f0fb084496275daf9b71d1cd635f2da8cbc (diff) | |
| download | chouette-core-bab85e7e646012b2cffabea5ff7987ecde6c0a25.tar.bz2 | |
Add api rest interface documents
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 15 insertions, 12 deletions
@@ -1,7 +1,7 @@ # Chouette2 [](http://travis-ci.org/dryade/chouette2?branch=master) [](https://gemnasium.com/dryade/chouette2) [](https://codeclimate.com/github/dryade/chouette2) Chouette2 is a web project in Ruby/Rails and can : -* Exchange transport data : Neptune, GTFS, Netex, CSV +* Exchange transport data : [Neptune](http://www.chouette.mobi/spip.php?rubrique61), [GTFS](https://developers.google.com/transit/gtfs/reference?hl=fr), [NeTEx](http://www.kizoom.com/standards/netex/), CSV * Edit transport data * Validate transport data * Offer a Restful API in read-only @@ -10,7 +10,7 @@ Chouette2 is a web project in Ruby/Rails and can : Requirements ------------ -This code has been run and tested on [travis](http://travis-ci.org/dryade/chouette2?branch=master) with : +This code has been run and tested on [Travis](http://travis-ci.org/dryade/chouette2?branch=master) with : * Ruby 1.8.7 * JRuby 1.6.8 (oraclejdk7, openjdk7, openjdk6) @@ -27,9 +27,9 @@ sudo apt-get install git Installation ------------ -Install [Postgres] (https://github.com/dryade/chouette2/doc/install/postgresql.md) +Install [Postgres] (https://github.com/dryade/chouette2/blob/master/doc/install/postgresql.md) -Install [JRuby] (https://github.com/dryade/chouette2/doc/install/jruby.md) +Install [JRuby] (https://github.com/dryade/chouette2/blob/master/doc/install/jruby.md) Get git code : ```sh @@ -80,6 +80,7 @@ sudo chmod a+x /var/lib/chouette/imports /var/lib/chouette/exports /var/lib/chou **Ruby** ```sh gem install bundler +bundle install bundle exec rake db:create ``` @@ -99,31 +100,33 @@ There is extensive usage documentation available [on the wiki](https://github.co API Documentation ----------------- -You can view the [xsd file](https://github.com/dryade/chouette2/doc/interfaces/api_rest_v1.xsd) for the API - - - +The description of the restful API is described in : +* [Description](https://github.com/dryade/chouette2/blob/master/doc/interfaces/Chouette_API_REST_v1.2.pdf) +* [XSD file](https://github.com/dryade/chouette2/blob/master/doc/interfaces/api_rest_v1.xsd) Example Usage ------------- +Launch the task to import and export asynchronously ```sh bundle exec rake jobs:work -bundle exec rails server ``` +Launch rails server +```sh +bundle exec rails server +``` License ------- -This project is licensed under the CeCILL-B license, a copy of which can be found in the [LICENSE](http://github.com/dryade/chouette2/LICENSE.md) file. +This project is licensed under the CeCILL-B license, a copy of which can be found in the [LICENSE](https://github.com/dryade/chouette2/blob/master/LICENSE.md) file. Release Notes ------------- -The release notes can be found in [CHANGELOG](http://github.com/dryade/chouette2/CHANGELOG.md) file +The release notes can be found in [CHANGELOG](https://github.com/dryade/chouette2/blob/master/CHANGELOG.md) file - Support ------- |