Ruby 2.3.1 Rails 4.2.6
rbenv or rvm recommanded
aglio -i apiary.apib -o public/developer.html
npm install -g aglio
$ gem install bundler
$ bundle install --without production
$ bundle exec rake db:migrate
$ bundle exec rails server
Run tests with
$ rspec
Test the API documentation compliance with Dredd
$ npm install -g dredd
- Reset DB to reset id sequence
- Populate database with Dredd specific seeds (cf file ./db/seeds/dredd.rb)
$ rake db:reset dredd:seeds
- Removes all newsletter subscriptions
- Removes all users
- Generates the dredd user
$ rake dredd
Dredd options are listed in dredd.yml file
Launch automatically tests with:
$ bundle exec guard
Launch automatically dredd and aglio (static documentation generation) with:
$ bundle exec guard -g apib
In order to redirect a mobile to the application from a SMS, we redirect toward a page on the website :
http://api.entourage.social/store_redirection
- If you visit this page from an iOS device you will be redirected to the Appstore
- If you visit this page from an Android device you will be redirected to the PlayStore
The logic and URL for the store can be found here : https://s3-eu-west-1.amazonaws.com/entourage-ressources/store_redirection.html