moi

Build Status Code Climate

development

requirements

  • ruby 2.1+
  • postgresql 9.3+
  • phantomjs (to run specs) See Installing phantomjs
  • aspell (for spellchecker). If this package is not found, it just won't check. You can install on mac with homebrew: brew install aspell --with-lang-es

getting started

  1. after cloning & switching to app

    $ git clone git@github.com:GrowMoi/moi.git moi-backend && cd moi-backend

  2. bundle

    $ bundle

  3. revise database configs

    $ cp config/database.yml.example config/database.yml

  4. create db, migrate it and seed it

    $ bundle exec rake db:create db:migrate db:seed

  5. boot the app

    $ bundle exec foreman start

resources

emails

we are using mailcatcher on dev environment

api

we are using apipie + maruku to document our api using markdown. All endpoints should be documented. Include Api::BaseDoc module and use #doc_for if you're documenting an endpoint which method isn't defined in the controller itself