zingsurfer / word_watch

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Word Watch 👀

Seeing is believing...

Today, your task is to bring Word Watch👀 to life! Find the API docs here. Essentially, you have two user stories:

  1. When the user comes to the page, they should see the top word and it's count on the right side of the page.
  2. When the user types a piece of text in text field and clicks the break down button, that word should be added to the master list of words. The piece of text could be a single word, or an entire essay. Make sure to read the API documentation carefully so you understand what needs to happen on the front end.

NOTE: The user should never have to refresh the page to see updated information.

If you finish these two user stories, consider:

  • if the users' input does not change the top word, there is no notification to the user that their word(s) was/were submitted. Can you provide some sort of notification to make a better user experience?
  • the current styling for the top word is pretty lame. Can you make it a little more exciting/clear while keeping it classy?
  • testing your Word Watch functions.

Workflow

Fork or clone this so you have your own Word Watch Repo.

You should commit as you normally would - when a new piece of functionality is built out and everything is clean and working. This should be an independent challenge, but we don't want you banging your head against the wall all morning. If you are stuck on setup or something weird, don't spend too long before you reach out to an instructor - we can get you going in the right direction. The point of this is not to frustrate you!

Submission

Please tag Amy and Cory in your final PR by 5pm to show us your 🔥awesome🔥 apps. We will comment with feedback! By that time, please have your project deployed to GitHub pages. Also, if you did run the API locally and were hitting that, please change the URL to the Heroku endpoints so it's easier for instructors to check real quick.

Environment Setup

Clone and navigate to the directory in your preferred way, or

git clone git@github.com:turingschool-examples/word_watch.git
cd word_watch

Then, get those dependencies:

npm install

If you run into issues where JavaScript you wrote isn't coming through the browser, try:

npm run build

Open your app on a webpack server:

npm start

And navigate to:

http://localhost:8080
  • Note make sure to keep npm start running during your development.

If you need to start the webpack server for some reason:

ctrl + c

To run the tests:

npm test

Word Watch API

  • Documentation can be found here
  • You can choose if you want to use ther Heroku API, or run the API locally. If you are using the Heroku API, remember that a lot of other students may be as well, so you'll have less control over if that top word is changing, etc.

About


Languages

Language:CSS 59.0%Language:JavaScript 41.0%