Skip to content

Latest commit

 

History

History
327 lines (266 loc) · 7.83 KB

README.md

File metadata and controls

327 lines (266 loc) · 7.83 KB
Raw

AREESH

Week 7 Group Project

This app uses speech-recognition technology to help you test your memory and sharpen your spelling skills!

Just tell the app the word you want to spell. It will appear on your screen briefly before disappearing.

Now over to you. Spell the word out loud, and AREESH will let you know if you get it right.

Team Roles

  • Product owner: Des
  • Scrum Master: Des
  • Vibe Master: Josh
  • Git Master: Jesse
  • FE Lead: Vinnie

Stand-Up Schedule

Daily @

  • 09:00 (+ check-in)
  • 11:00 (+ energizer game)
  • 13:00
  • 15:00 (+ energizer game)
  • 17:00

User Stories

MVP

As a user:

  • I want to be presented with the correct spelling of a word when I say it out loud so that I can learn how to spell it
  • I want to be presented with the definition the word when I say it out loud so that I can make sure it is the word I meant
  • I want to get feedback, letter-by-letter, when I spell a word out loud so I that I can add it to my active vocabulary and train my memory
  • I want to be able to see my total number of completed words so I can keep track of my learning progress during each time I play
  • I want to be able to see the rules of the game when I log in, so I know how to play

Stretch

As a user:

  • I want to be able to view a graph displaying my completed words each time I play, so I can track my learning progress in the short term
  • As a registered I want to be able to view a graph displaying my history of completed words since I signed up, so I can track my learning progress long term

Views (Client Side - MVP)

name purpose
Login View for user to enter their login credentials
Register View for user to sign up for the App
Home View to display a welcome message, game instructions and a 'start' button
WhichWord View to prompt user to verbally provide the word they want to spell, then take that word as a verbal input
WordDefinition Displays the word, along with a definition, before disappearing (2s) so the user cna try to memorise it
LiveSpelling Displays the letters the user has correctly spelled so far in green. If the user mispells a letter it displays in red and redirects to the 'word definition' view
Winner Displays a congratulatory message/animation to the user when they have succesfully spelled the word
ContactDetails View for user to contact the Areesh team

Reducers (Client Side)

name purpose
auth Store information regarding user logins, auth status and auth errors
users Store all registered users
wordHistory Store current users word attempts
wordLibary Store list of Words and definitions

Store (made up of the Reducers)

const state ={
    auth,
    currentWord,
    wordHistory,
    wordLibrary,
    users //stretch
}

const auth = {
    isFetching: false,
    isAuthenticated: false,
    user: null,
    errorMessage: ""
}


const currentWord = {
    word: 'apple',
    definition: 'The round fruit of a tree of the rose family, which typically has thin green or red skin and crisp flesh.',
    // the time string needs to be converted back to a date object upon extraction
    startTime: 'Fri May 03 2019 12:22:50 GMT+1200 (New Zealand Standard Time)',
    attemptDuration: null,
    lettersCorrect:[],
    wordCorrect:false
}

const wordHistory = [
    {
        word: 'apple',
        // the time string needs to be converted back to a date object upon extraction
        startTime: 'Fri May 03 2019 12:22:50 GMT+1200 (New Zealand Standard Time)',
        attemptDuration: 4.2,
        lettersCorrect:[
            true,true,false,false,false
        ],
        wordCorrect:false
    },
    {
        word: 'banana',
        // the time string needs to be converted back to a date object upon extraction
        startTime: 'Fri May 03 2019 12:22:50 GMT+1200 (New Zealand Standard Time)',
        attemptDuration: 3,
        lettersCorrect:[
            true,true,true,true,true,true
        ],
        wordCorrect:true
    }
    
]

//If the user wants to pick from a list of words or a set difficulty
const wordLibrary = [
    {
        word: apple,
        definition: 'The round fruit of a tree of the rose family, which typically has thin green or red skin and crisp flesh.'
    },
    {
        word: banana,
        definition: 'A long curved fruit which grows in clusters and has soft pulpy flesh and yellow skin when ripe.'
    }
]

//not needed for mvp but perhaps for high-score stretch 
const users = [
    {
        firstName: 'John',
        lastName: 'Doe',
        userName: 'johndoe',
        hourlyWage: 100
    },
    {
        firstName: 'Jane',
        lastName: 'Doe',
        userName: 'janedoe',
        hourlyWage: 100
    },
    {
        firstName: 'Mickey',
        lastName: 'Mouse',
        userName: 'houseofmouse',
        hourlyWage: 100
    }
]

```BC...

Actions

users

type data purpose
RECEIVE_USERS users retreive the users from the server

words

type data purpose
SAVE_WORD_DATA wordData store data set of users word attempt
SAVE_WORDS words store list of words and definitions

API (Client - Server)

Method Endpoint Protected Usage Response
Post /api/auth/login Yes Log In a User The Users JWT Token
Post /api/auth/register Yes Register a User The Users JWT Token
Post /api/speech/transcribe Yes Transcribe an audio file to text Transcript of audio file (string)
Post /api/speech/blob Yes Save user speech as audio file on server side HTTP status
TBC...

Route - POST /api/auth/login

Data in

{
    userName: 'john',
    password: 'god' //password given as plain text
}

Data Out

{
    JWT: 'sdf8fd74ergdifgnerg05g'
}

Route - POST /api/auth/register

Data in

{
    userName: 'sonic-da-hedgehog',
    firstName: 'Nicholas',
    lastName: 'Cage',
    imageURL: './sonic.png'
    password: 'god' //Password given as plain text
}

Data Out

{
    //Redirect to login page
    status: 200, //Unsure of exact response at this stage but will be some kind of status 
    status: 400 
    //200 ok
}

Route - POST /api/speech/blob

Data in

{
    //TBC - blob?
}

Data Out

{
   fileName
}

Route - POST /api/speech/transcribe

Data in

{
    fileName 
}

Data Out

{
   transcript: 's o n i c'
}

Routes n, n+1...

TBC

DB (Server Side)

There should be one table for MVP

Users

Column Name Data Type
id Integer
user_name String (unique)
first_name String
last_name String
password_hash string
image_url string

Setup

Run the following commands in your terminal:

npm install
npx knex migrate:latest
npx knex seed:run

create a .env file, and procure the JWT secret from an admin

To run in development:

npm run dev

To run in production:

npm start

Heroku!!!

Creating your app

Create your app with heroku create [name]

You can check that this was successful by running heroku apps to view a list of your apps

Adding postgres

AREESH Login

Add postgresql (hobby dev) to your app at https://dashboard.heroku.com/apps/[APP NAME HERE]/resources

Check that pg has been added by running heroku addons to ensure the postgresql db is on your app

Deploying!

I have created several npm scripts that will be useful for deploying your app to heroku easily.

To push your local master branch to your heroku app:

npm run h:deploy

Run heroku migrations:

npm run h:migrate

Run heroku seeds:

npm run h:seed

If ever you need to rollback, you can also:

npm run h:rollback

Ta-Da!

Your app should be deployed!