Dictionary

This is a simple dictionary using Ruby on Rails and the Oxford Dictionary API. You can access the application hosted here.

Installation

Installation is quick and easy. You will need to sign up for your set of API keys at Oxford Dictionaries API developer's portal.

Set up Rails app

First, install the gems required by the application:

bundle install

Next, execute the database migrations/schema setup:

rails db:setup

Then run the Rails server:

rails s

Objective Checklist

• Ability to enter a dictionary term, via form page
• Ability to retrieve the corresponding definition for the term entered
• Ability to maintain a list of the last 5 terms searched
• Ability to handle exception errors, gracefully
• Ability to log such exceptions to assist in troubleshooting

New Objectives

• Protect the params from the forms
• Use a service object to handle out API calls
• Try to DRY up the controller as much as possible, to keep the code readable
• Allow for easy implementation of additional dictionaries
• Log exceptions in a better manner, they have been moved from the WordController. Will need to see how to get the logger working properly. Error handling is unaffected on client side.

Contributing

Issues and pull requests are welcome at https://github.com/rukshanuddin/final_frontend. This project as well as all other content on my GitHub are intended to be safe, welcoming, and open for collaboration.

Users are expected to adhere to the Contributor Covenant code of conduct

Authors

Rukshan Uddin - Initial work - GitHub/rukshanuddin - Personal Site

License

This project is licensed under the MIT License - see the LICENSE file for details.