Skip to content

andrewgsalmon/hit-me

Repository files navigation

Introducing...

View a demo of Hit Me!

Have you ever thought to yourself: "I need some music while I'm working, but I can't decide what to listen to... I need a recommendation!"

We've all been there, right? Me too! Well, the Hit Me app helps you with just that. Just open the app, decide on the genre you want, and how obscure or popular you want the recommendation to be. Tell the app what you're looking for, and your soundtrack for the day has been set!

NEW: Want music that sounds like one of your favourite artists? You can discover this way too!

Like the recommendation? Save it, refer back to it later, or even find similar artists! Or - leave a comment to share what you think of the artist!

Get recommendations by genre

Get recommendations based on favourite music

Save artists to your profile

Comment on artist recommendations you like

Start using Hit Me

No need to download and install... Start using it now on the live web app!

Interested in the code and building upon it? Cool! See instructions below:

Installing 'Hit Me' locally

To use the app locally, you will need to install this repository (front end), as well as the back end repository.

Install the back end here.

Front end installation

  1. Clone the app to your local machine
  2. Install the necessary dependencies (ex. npm i via your CLI)
  3. Create a .env file in your root directory. Before we add anything here, we will need to register for a developer account with Spotify.
  4. Create a Spotify account, or login if you already have one. Once registered and logged in, click "Create App". Add a name and description of your choosing, set the website URL to localhost:3000, and your redirect URI to localhost:3000/home.
  5. Once submitted, go to your new app's settings and make note of your client ID and client secret. We'll need these for your .env file.

Configure your .env file

The .env variables required are dictated in the .env.sample file included in this repo.

Back end installation

  1. Clone this back end repo locally.

  2. Once cloned, install the necessary dependencies (ex. npm i via your CLI).

Create a new MySQL database

Create a new schema in a MySQL database, which will allow you to register for an account, leave comments on recommended artists, and save artists to your profile. Make note of what you called your DB, as you will need this for your .env file - or call it "hit_me", as is named by default in the .env.sample file in the backend repo!

Add and configure your .env file

Instructions for .env configuration are included in the .env.sample file in the backend repo.

Starting your server

Once the above has been completed, complete the following steps in your CLI:

  1. npm run migrate
  2. npm start

Starting the front end

Once the server is up and running, just run npm start in your CLI, and you are up and running!


I'd love to hear from you! Reach out below:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published