MusicGuessr

Description

Musicguessr is a website hosting a quizz game where the objective is to guess the title of a song.
The game is based on a trial and error system, where the player has to guess the title of the song by trying different titles, and getting information about the similarity between the title he entered and the right answer.
The songs are song from the officials spotify playlists containing the top 100 songs streamed in the world each year.
The dataset used is available here. A demo of the game is available here.

Development environment

Install development tools

• Install xampp
• Install composer When asked for the command-line PHP, use the one in xampp (C:\xampp\php\php.exe by default), and add it to your PATH (check the box)
• Install npm

Clone the repository

for SSH

git clone [email protected]:HE-Arc/MusicGuessr.git

for HTTPS

git clone https://github.com/HE-Arc/MusicGuessr.git

Configure the environment

• Install the dependencies

composer install
npm install

• Copy the .env.example file and rename it .env
• Generate a key for the application

php artisan key:generate

• Start the apache and mysql services in xampp
• Create a database and configure the .env file with the database credentials
• Run the migrations

php artisan migrate

• Run the seeders

php artisan db:seed

• Compile the assets

npm run dev

Run the application

• Start the apache and mysql services in xampp
• Start the application

php artisan serve

• Go to localhost:8000
• Enjoy the game !
• To stop the application, press Ctrl + C in the terminal
• To stop the apache and mysql services, press Stop in xampp

Run the tests

• Run the tests

php artisan test