Iro

Iro uses spaced repetition learning to teach you the words for a variety of colors in the Japanese language.

Credits

Matt Patterson and Josh Struve.

Live App

IO

UI

Branding

Log In

Sign Up

Dashboard

Question

Correct Answer

Incorrect Answer

Technology

PERN stack

• PostgreSQL
• Express.js
• React.js
• Node.js

Endpoints

Supported endpoints:

• /auth/token
• /language
• /language/head
• /language/guess
• /user

Sample Requests/Responses

/auth/token

• Method: /POST
• Request Params:
  • passwords must include at least 1 upper and lower case letter, 1 special character and 1 number

  {
     "username": "Marco Amigo",
     "password": "Marco_password1"
  }

• Response
  • 200

  {
    "authToken": "jwt generated bearer token"
  }

  • 400

  {
    "error": 'Incorrect username or password',
  }

/language

• Method: /GET
• Request Params: database user and language id
• Response
  • 200

  {
    "language": {
     "id": 2,
     "name": "Japanese",
     "user_id": 2,
     "head": 13,
     "total_score": 0
    },
    "words": [
     {
      "id": 13,
      "language_id": 2,
      "original": "Orange",
      "translation": "Orenji",
      "next": 14,
      "memory_value": 1,
      "correct_count": 0,
      "incorrect_count": 0,
      "hex": "#FFB74D",
      "script": "orange.svg"
    },
     // ...
  }

  • 404
    • no languages retrieved from the database

    {
      "error": "You don't have any languages"
    }

/language/head

• Method: /GET
• Request Params: database language id
• Response
  • 200

  {
    "nextWord": "Orange",
    "total_score": 0,
    "wordCorrectCount": 0,
    "wordIncorrectCount": 0,
    "hex": "#FFB74D",
    "script": "orange.svg"
  }

  • 400
    • no words in the database

    {
      "error": "Missing head"
    }

/language/guess

• Method: /POST
• Request Params:

  {
    "guess": "orenji"
  }

• Response:
  • 200

  {
    "nextWord": "Yellow",
    "wordCorrectCount": 1,
    "wordIncorrectCount": 0,
    "hex": "#FFB74D",
    "script": "orange.svg",
    "total_score": 1,
    "answer": "Orenji",
    "original": "Orange",
    "isCorrect": true
  }

  • 400
    • request body is invalid or given empty response

    {
      "error": "Missing 'guess' in request body"
    }

/user

• Method: /POST
• Request Params:

  {
    "name": "Marco Plebe",
    "username": "plebeus"
    "password": "PlbMrc_1_@"
  }

• Response:
  • 200

  {
   "id": 3,
   "name": "Marco Plebe",
   "username": "plebeus"
  }

  • 404

  {
   "error": "Password must contain one upper case, lower case, number and special character"
  }

Configuring Postgres

For tests involving time to run properly, configure your Postgres database to run in the UTC timezone.

1. Locate the postgresql.conf file for your Postgres installation.
   1. E.g. for an OS X, Homebrew install: /usr/local/var/postgres/postgresql.conf
   2. E.g. on Windows, maybe: C:\Program Files\PostgreSQL\11.2\data\postgresql.conf
   3. E.g on Ubuntu 18.04 probably: '/etc/postgresql/10/main/postgresql.conf'
2. Find the timezone line and set it to UTC:

# - Locale and Formatting -

datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
timezone = 'UTC'
#timezone_abbreviations = 'Default'     # Select the set of available time zone

Scripts

Start the application npm start

Start nodemon for the application npm run dev

Run the tests mode npm test

Run the migrations up npm run migrate

Run the migrations down npm run migrate -- 0