moi

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

0. after cloning & switching to app

$ git clone [email protected]:GrowMoi/moi.git moi-backend && cd moi-backend

1. bundle

$ bundle

2. revise database configs

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

3. create db, migrate it and seed it

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

4. boot the app

$ bundle exec foreman start

resources

• documentation
• guidelines
• moi-front-end
• api endpoints (depends on environment)

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