Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 2.48 KB

README.md

File metadata and controls

48 lines (33 loc) · 2.48 KB
Raw

#Uncrossword

This is an autocomplete app for people who solve crossword puzzles. Enter letters at specific positions and get all the words in the dictionary with letters at those positions.

Click Here to use the app.

Build Status Code Climate Test Coverage Dependency Status devDependency Status

How we built it

Autocomplete Module

  • import a list of words into an array called words.
  • search through list of words for a string and return list of suggestions.
  • record the string that was searched for (for stats and graphs!).

Autocomplete HTTP Server (API)

  • serve an html page with a search box.
  • expose the ac.findWords method as an API endpoint /find/:word
  • display the definition of a word when the person clicks/taps (or navigates using the keyboard arrows - for extra credits!) to their desired word.

Back end

  • create an endpoint in server.js for the format: /define/:word which uses the ac module's findWords method to lookup word suggestions and returns an array of these suggestions as the http response

  • Integrate - Search for Tweets based on the word the person looked up to give them context on how to use it.

Front end / UX

  1. Wireframe a great word searching user experience!

  2. Using the knowledge of QUnit for front-end TDD you gained in the last two weeks, build great user experience for searching words!

Repo Owner

  • Add a .jshintrc file to your project
  • learn about pre-commit hooks and add a pre-commit hook to lint your code before anyone can commit (unlinted) code
  • Learn about CodeClimate
  • Learn about (Continuous Integration) Travis-CI and
    • add .travis.yml to your repo
    • add "build passing" badge to your readme
  • Add Dependencies Badge to your readme.
  • Deploy to Heroku.