Skip to content

Latest commit

 

History

History
60 lines (50 loc) · 2.17 KB

README.md

File metadata and controls

60 lines (50 loc) · 2.17 KB

Build Status Coverage Status Greenkeeper badge

spotifight

Synopsis

In each matchup, choose a favorite between two songs. At the end, you'll have a winner!

Live app

See the app live at spotifight.me.

Usage

Initial

Clone the repository:

git clone https://github.com/joncass/spotifight.git

Start

Move into the directory and start the app

cd spotifight
npm run start

Tests

Run tests with or without coverage

npm run test
npm run coverage

Server

Longer term I would like to put the server/index.js logic onto a server. For now, I run it locally with Node, and check in the data files it generates. It cannot be run from the browser because it requires Spotify developer credentials, which should not be exposed client-side. If you want to generate your own data files, sign up for a Spotify developer account, and create a secrets/spotifyWebAPI.js with contents

exports.clientId = [YOUR CLIENT ID]
exports.clientSecret = [YOUR CLIENT SECRET]

and then run

node server

Technologies

Built using:

Testing and CI/CD with:

License

MIT License

Contributing

Contributions welcome! I don't have a contributing guide (yet), but feel free to open an issue if you have a suggestion for a change and/or would like to make a pull request. NB: I will be looking for 100% test coverage.