Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 2.22 KB

README.md

File metadata and controls

33 lines (23 loc) · 2.22 KB
Raw

Musixmatch - Who sings?

This is a music-based quiz game I built as per requirements provided by Musixmatch

Demo hosted on Vercel

User journey

The user has to log his name to register an account and start the game. His/Her account is stored in the browser localStorage, which is a convenient compromise to persist without a DB, since localStorage expires only when the user deletes it manually. It survives tab change an browser close and opening.

The user can play as many games as he/she wants, and everytime a game finishes, the scores is saved inside the user's account. It is then used to update the user's personal scores table and the global high scores table.

Technologies used

Here are the technologies being used

  • Next.js as the core framework
  • React as the rendering library
  • React DOM: this is the React package that acts as a bridge between React itself and the DOM, so it makes possibile to render React components into a web page's DOM by using React's own virtual DOM and diffing algorithm
  • Redux Tooklit as the main tool to store a global state object across the entire application
  • Typescript as the safety layer above JavaScript, to ensure less errors during development
  • Css modules as the main tool to develop modular style with unique component-centered classes
  • Jest as the main unit test framework
  • Musixmatch Developer API as the main source of data

Run locally

  1. Run npm ito install all the dependencies
  2. Once installted, you can run npm run dev to start the local server on http://localhost. The default port used will be 3000, otherwise another if it is already occupied by another process
  3. Other useful commands:
    • create a production build (useful to check for any error before creating a commit): npm run build
    • run unit tests (written in Jest): npm run test