joaoqalves / js-training-practice

JS Training practice project

JS Training: The Quiz Project

What is it ?

The quiz is a simple quiz built on client from a json file.

The has a simple schema:

Property	Definition
title:String	Title of the quiz
questions:Array<Object>	Config of questions
questions[]:Object
questions[].problem:String	Question's title
questions[].input:Object	Field to display
questions[].input.type:String	'radio', 'checkbox', 'inputs' or 'input' (default)
questions[].input.options:Array	labels of the options (only for 'radio', 'checkbox' or 'inputs')

Why?

It's a project to practice acquired knowledge in JS Training Course refactoring this code.

This code is not meant to be well done, but meant to be refactored. This way, you can refactor progressively fixing the main mistakes of the code.

How?

Please read the contributing guidelines

Commands

npm run dev

Runs the project on watch mode.

npm run test

Executes end-to-end tests on the app to check your change haven't broken anything.

⚠️ Caution! ⚠️

Tests are run with selenium and require to have Java JDK installed: http://www.oracle.com/technetwork/java/javase/downloads/index.html.

The tests were run successfully with Chrome v62

npm run test:dev

Executes end-to-end tests on watch mode. Tests will be reexecuted every time.

npm reset

Safely reinstalls the project.

Refactor phases

1. Operators And Closures

refactor/operators-closures

• Change scopes of variables from global scope to local scope.
• Declare variables with let, const or var.
• Use destructuring when possible.
• Use operator expressions for conditionals and value assignment.

2. Strings

refactor/strings

• Convert strings to template strings.

3. Functions

refactor/functions

• Split all logic in functions as pure as possible.
• Use new arrow functions syntax when possible.
• Respect functional principles:
  • Immutability
  • Absence of side effects
  • Function don't depend on state
  • Functions with 1 input/ 1 output.