/doogle

Doogle dictionary

Primary LanguageRuby

Doogle

Code Climate Build Status

Doogle dictionary API.

This application basically is divided in two parts:

  1. Rails Dictionary API - using http://www.dictionaryapi.com/
  2. SPA-ember (Single Page Application) using emberJS
  3. SPA-angular (Single Page Application) using angularJS

Features

  • The application stores all the words and definitions which are searched.

  • If the word is already searched, it should be stored in the database and not consumed by the DictionaryAPI.

How to setup

  1. Setup the API KEY from DictionaryAPI

    • You should create an API_KEY in the following website: http://www.dictionaryapi.com/
    • Once you have created, you might use dotenv and create ENV['API_KEY'] in your environment.
  2. Running the application

$ bundle install
$ rake db:create && rake db:migrate

How to run the app

$ foreman start

Foreman will start:

Using

  • rails-api
  • active-model serializers
  • rspec
  • foreman
  • simplecov
  • puma
  • vcr
  • spring

Contributing

  1. Fork it
  2. Create your feature branch: git checkout -b my-new-feature
  3. Run tests: rake
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Create new Pull Request