From 57a002f4e582e10d18da58015a7b3217d1c84993 Mon Sep 17 00:00:00 2001 From: eniteCZ <43375026+eniteCZ@users.noreply.github.com> Date: Wed, 7 Dec 2022 21:22:44 -0500 Subject: [PATCH] Updated the Read Me --- README.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5562e093e..a87f92c26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ -# This is your readme -You are required to fill it in with documentation similar to that found in the Sequelize example for the course as part of your final project. +# Music: New Horizons +This is an INST377 final project website by Filip Radmanovic and Minghan Cai. Please visit our webpage at: + +https://mingc98.github.io/Group102-01-Final-Project-Music-NewHorizon/index.html + +## Broad description +While using spotify most of us search for a song we know and listen to and then either choose a playlist with what is already know or we let the algorithm take the reigns and play songs for us based on our known preferences. + +The intent of the project is to provide the user with song suggestions for a particular genre that have not been generated based on their preferences, thus broadening their musical horizon. When a user selects a genre and presses the button, we show a list of 9 randomly selected songs along with the links to them on Spotify, a galery of their album covers and a chart of their length. Once a user has picked a song they can click on the link which will tak them to spotify web page where they can listen to it. + + + +## Usage manual +This page should work on all mainstram browsers on mobile and fixed divices. + + * First when you open the page, it will load a selection of genres to the dropdown menu prompting you to select a genre + * Once you have selected a genre give the page a second to retrieve a list of songs + * Then press the "Broaden my horizon" button + * You can look at the names of the songs and select whichever you like best, you will be redirected to spotify where you can listen to it. + * If you want to know more about us, please visit the "About us" link at the bottom of the page. + + +## API +We are using the Spotify API. For details please refer to the official documentation: + +https://developer.spotify.com/documentation/web-api/ + +## Visualizations +We use 2 visualizations in this project: + * An image galery of album covers handled internaly by our code. + * A chart of song lengths using the chart.js library + -### How to use Markdown -Markdown is a text notation system used in Discord, Whatsapp and similar to structure pages without writing HTML at all. You'll be using it for your documentation. -* [Markdown guide](https://www.markdownguide.org/cheat-sheet/) \ No newline at end of file