Wordset API is the Rails/Grape API back-end for Wordset. Wordset is a collaborative, structured dictionary.
To get it working locally, you will also need to clone and set up the Ember front-end, Wordset UI.
We use the latest version of Ruby, 2.1.5. We recommend using RVM to manage Ruby versions.
This project requires MongoDB. On OS X with Homebrew, this is as easy as brew install mongo, but see Mongo Installation Instructions for more information on your platform.
git clone https://github.com/wordset/wordset-api.gitthis repository- change into the new directory
bundle install
Create a file called .env in the root of the project folder. To be fully functional,
it needs all of these fields filled out. Defaults are included here.
API_HOST=http://localhost:3000
UI_HOST=http://localhost:4200
FACEBOOK_APP_ID={{YOUR ID}}
FACEBOOK_SECRET={{YOUR SECRET}}
GITHUB_ID={{YOUR ID}}
GITHUB_SECRET={{YOUR SECRET}}
rails server- Visit the API at http://localhost:3000.
- Make sure the Ember front-end (Wordset UI) is running if you want to see the front-end.
We use rspec for tests.
rspec
When something breaks, or when committing a bug fix, please add a test case to the spec file.