ethanpasta / KnowYourMusic

A Song Lyric Guessing Game

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

KnowYourMusic - UNDER CONSTRUCTION

App Screenshot

App Screenshot1

Introduction

KnowYourMusic was initially developed as a end-of-year portfolio project at Holberton School.

We all like singing to our songs. However, most of the time we don't really know the lyrics to the songs were singing. One solution would be to read song lyrics all day util we memorize them, but that wouldn't be very fun.. That's why you should play KnowYourMusic!

A game that determines how well you know your music. Login with your Spotify account and play with your own library, or play with one of the weekly public playlist (no login needed). See how many songs you can guess right!

Game data and basic user data is stored for a full user experience.

Technologies

Front-end

  • React (with hooks)
  • Redux for state management (with the official Redux Toolkit)
  • Feature-first architecture design, and a React pattern of presentational components vs containers for better seperation of concerns.
  • Socket.IO client side

Back-end

  • Node.js + Express
  • MongoDB
  • Socket.IO for real-time communication during gameplay
  • A lyric scraping service with multiple sources

Getting Started πŸ‘‡

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Requirements

For development, you will only need Node.js and a node global package, npm, installed in your environement.

$ node --version
v8.11.3

$ npm --version
6.1.0

Installing

$ git clone https://github.com/ethanpasta/KnowYourMusic
$ cd KnowYourMusic
$ npm install && cd client && npm install

Deployment πŸ”₯

npm run dev (dev:client for client only and dev:server for server only)

Authors πŸ™‹

About

A Song Lyric Guessing Game


Languages

Language:JavaScript 75.3%Language:CSS 15.5%Language:HTML 9.2%