wordupapp / wordup

An application to improve your vocabulary

Home Page:https://wordup-app.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

wordUp

Up your vocabulary

Looking to improve your everyday vocabulary? Look no further. Whether you are in school, in the workplace, or merely want to add some eloquence to your dialogue, this tool will analyze your speech and then provide you with quizzes and interactive games to boost your vocabulary level.

Motivation

While there are many indicators of a broad education, a strong command of language is certainly a major component. There are some existing tools today which can look at your spelling or your grammar, but not too many which can truly improve multiple aspects of your vocabulary. This tool aims to utilize diagnostics to analyze your current level, and then provide both fun and effective exercises to broaden the expanse of your vocabulary. The vocal diagnostic prompts also ensure that improvements are seen not only in your passive vocabulary (comprised of words you understand), but in your active vocabulary as well (words you not only understand, but actively use in your speech).

Build Status

  • [DISCUSS TRAVIS-CI WITH GROUP]

Screenshots

  • [INSERT LOGO]
  • [INSERT SCREENSHOTS]

Tech Used

Built with

Features

  • Vocal speech analysis
  • Interactive games
  • User level assignment
  • Challenging quizzes based on user's level
  • Custom, tailored word suggestions for each user
  • Complex and interactive data visualizations for each user
  • User profile page

How To Run Locally

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer.

You'll also need Neo4j, a popular graph database, as well as PostgreSQL, a traditional object-relational database.

Lastly, you'll need to make accounts for several APIs:

  • twinword
    • Natural language processing
  • ROSETTE
    • Text analysis
  • Google API
    • Not necessary to run application, but only if you would like to test login through a Google username/email account

From your command line:

# Clone this repository
$ git clone https://github.com/wordupapp/wordup.git

# Go into the repository
$ cd wordup

# Install dependencies
$ npm install

# Run the application
$ npm run start-dev

API Reference

Tests

  • [DESCRIBE TESTS AND SHOW HOW TO RUN THEM WITH CODE EXAMPLES]

How To Use

  1. Go to wordUp and make a user account or log in with your Google account
  2. Record yourself using a sample prompt or your own imagination to get your first diagnostic baseline and an appropriate vocabulary level
  3. Start playing games, completing quizzes, and reviewing the recommended words section to improve your vocabulary!

Credits

License

  • [INSERT APPROPRIATE LICENSE ONCE IT HAS BEEN ADDED TO REPO]

About

An application to improve your vocabulary

https://wordup-app.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 98.4%Language:CSS 1.2%Language:HTML 0.4%