diff options
| author | Luc Donnet | 2017-12-22 15:28:21 +0100 | 
|---|---|---|
| committer | Luc Donnet | 2017-12-22 15:28:21 +0100 | 
| commit | 7ef4eddb56231f83930b3a560a0ccb3ac8ca1814 (patch) | |
| tree | 5b8f95bd15b6f32c8784ea046abe465f7dadf309 /README.md | |
| parent | 3520953b696a138b9f0b049ff8af636a3b575bcd (diff) | |
| download | chouette-core-7ef4eddb56231f83930b3a560a0ccb3ac8ca1814.tar.bz2 | |
Fix README outdated documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 162 | 
1 files changed, 9 insertions, 153 deletions
| @@ -1,20 +1,15 @@  # Chouette2 [](https://travis-ci.org/afimb/chouette2) [](https://gemnasium.com/afimb/chouette2) [](https://codeclimate.com/github/afimb/chouette2)  Chouette2 is an open source web project in Ruby/Rails to edit and view transport offer data. It is designed as an [SaaS](http://en.wikipedia.org/wiki/Software_as_a_service) platform and can : -* Exchange transport data : [Neptune](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/neptune/), [GTFS](https://developers.google.com/transit/gtfs/reference?hl=fr), [NeTEx](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/netex/), CSV +* Exchange transport data + * [Neptune](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/neptune/), + * [GTFS](https://developers.google.com/transit/gtfs/reference?hl=fr), + * [NeTEx](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/netex/)  * Edit transport data  * Be requested via a read-only [Restful API](https://en.wikipedia.org/wiki/Representational_state_transfer)  * [Import, Export and Validate transport data asynchronously](http://github.com/afimb/chouette)  * Use a [multi-tenancy database](http://en.wikipedia.org/wiki/Multitenancy) -Chouette2 uses Rest Web Service API from [chouette](http://github.com/afimb/chouette) (another git project) to import, export and validate various transport data. - -Feel free to test and access to the free SaaS web site at [http://appli.chouette.mobi](http://appli.chouette.mobi/chouette2/users/sign_in). Two types of access are granted : -* A demo organisation with an existing Public Transport dataset -  * login : demo@chouette.mobi -  * password : chouette -* Create your own organisation : follow the link "Sign up" ("S'inscrire") -  Release Notes  ------------- @@ -23,162 +18,28 @@ The release notes (in French) can be found in the [CHANGELOG](./CHANGELOG.md) fi  Requirements  ------------ -* [Chouette IEV 3.X Web Service](https://github.com/afimb/chouette) (requires Postgresql and Java) -* Ruby 1.9.3 or 2.1.6 -* Bundler 1.10.3 -* Proj 4.8.0 - -External Deps -------------- - -Install Chouette IEV 3.X Web Service  [see how to](https://github.com/afimb/chouette/readme.md) -Next steps assumes that : -* a Chouette IEV Web Service is running (on localhost, port 8080) -* a Postgres database exists (chouette2 on localhost, port 5432) with a postgres user (chouette, with password chouette) - -On Debian/Ubuntu/Kubuntu OS : assumes that the depot contains the correct version -```sh -sudo apt-get install libpq-dev -sudo apt-get install git -sudo apt-get install unzip -sudo apt-get install proj-bin -sudo apt-get install libproj-dev -sudo apt-get install make -sudo apt-get install libmagic-dev -``` - -If Linux distribution doesn't publish an RVM package, -install [RVM from sources](./doc/install/rvm.md) - -Install ruby 2.1.6 -```sh -rvm  install ruby-2.1.6 -rvm --default use 2.1.6 -``` - -Install bundler 1.10.3 -```sh -gem install bundler -v 1.10.3 -``` - -Installation ------------- - -On Debian, chouette can also be installed as a package : see [debian packages](http://packages.chouette.cityway.fr/debian/chouette) - -Install web application - -Get git source code : -```sh -cd -git clone -b V3_1 git://github.com/afimb/chouette2 -cd chouette2 -``` -Download gem librairies -```sh -bundle install -``` -Update database schema -```sh -RAILS_ENV=production bundle exec rake db:migrate -``` -Prepare static resources (assets) -```sh -RAILS_ENV=production bundle exec rake assets:clobber assets:precompile -``` - -Configuration -------------- - -Configure for Generating URLs in Action Mailer Views. -* Edit [production.rb](./config/environments/production.rb) and change ```config.action_mailer.default_url_options``` -* see [Action Mailer Configuration documentation](http://guides.rubyonrails.org/action_mailer_basics.html) - -Configure assets access (Must be true if you use Webrick, or false if you use Apache or Nginx). -* Edit [production.rb](./config/environments/production.rb) and change ```config.serve_static_files``` - -Configure SMTP settings. -* Edit [production.rb](./config/environments/production.rb) and change ```ActionMailer::Base.smtp_settings``` -* see [Action Mailer Configuration documentation](http://guides.rubyonrails.org/action_mailer_basics.html) - -Configure e-mail send address visible on the e-mail sent when a user registers, re-initialises its password, ... -* Edit [production.rb](./config/environments/production.rb) and change ```config.mailer_sender``` - -Configure Rails secret key. -* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```secret_key_base``` -* see [Rails documentation](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml) - -Configure address of the Chouette IEV Web Service. -* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```api_endpoint``` - -Configure Google Analytics Key. -* Edit [secrets.yml](./config/secrets.yml) and change```google_analytic_tracker``` -* see [Google Analytics](https://www.google.fr/intl/fr/analytics/) +* [Import, Export and Validation Operations](https://github.com/af83/stif-boiv-iev) are in another project in Java -Configure IGN Géoportail Key. -* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```geoportail_api_key``` -* see [API Géoportail documentation](http://api.ign.fr/accueil) - -Configure the way that Chouette2 sends e-mail. -* Edit [devise_async.rb](./config/initializer/devise_async.rb) and uncomment and set```Devise::Async.enabled``` ( true if you want to use asynchronously and false otherwise ) -* see [Devise Async specification](https://github.com/mhfs/devise-async) - -Configure OSRM Backend URL -* Edit [secrets.yml](./config/secrets.yml) and change```osrm_endpoint``` -* see [Project-OSRM](https://github.com/Project-OSRM/osrm-backend/wiki/Api-usage-policy) - -Run ---- - -Launch the task if you want to send mail asynchronously (See previous chapter to desactivate it) -```sh -RAILS_ENV=production bundle exec rake jobs:work -``` -This task may be added in system start-up configuration - -Launch rails server with [WEBrick](http://guides.rubyonrails.org/command_line.html#server-with-different-backends) ( default RoR web server, note: webrick runs on default port 3000) -```sh -RAILS_ENV=production bundle exec rails server -``` - -This task may be added in system start-up configuration. -Instead of using WEBrick, Rails application may be deployed on [Phusion Passenger](https://www.phusionpassenger.com/) with an [Apache](http://httpd.apache.org/) or [NGinx](http://nginx.com/) front-end, to make server faster and more robust. - -Apache like NGinx can serve static resources, -so change parameter ```serve_static_files``` to false in [production.rb](./config/environments/production.rb) - -Test ----- +Install +------- -```sh -bundle exec rake db:create -bundle exec rake db:migrate -bundle exec rake spec -``` +See [installation manual](./INSTALL.md)  More Information  ---------------- -Complete docs (in French) can be found on the [project website](http://www.chouette.mobi/developpeurs).  Some technical articles are available [on the wiki](../../wiki) too.  API Documentation  ----------------- -The description (in French) of the read-only restful API is described in : -* [User manual file](./doc/interfaces/Chouette_API_REST_v1.2.pdf) -* [XSD file](./doc/interfaces/api_rest_v1.xsd) +TODO  License  -------  This project is licensed under the CeCILL-B license, a copy of which can be found in the [LICENSE](./LICENSE.md) file. -Project-OSRM Licence -------------------------- - -Project-OSRM is licensed under the [ODbL](http://opendatacommons.org/licenses/odbl/) licence. -  Release Notes  ------------- @@ -188,8 +49,3 @@ Support  -------  Users looking for support should file an issue on the GitHub [issue tracking page](../../issues), or file a [pull request](../../pulls) if you have a fix available. - -Credits -------- - -Thanks to Ingolf for his [photo](https://www.flickr.com/photos/ingolfbln/7663851694) under CC BY-SA 2.0 license | 
