Your Favourite Year In Music

An app that analyzes your liked songs in spotify to determine your favourite year in music.
Explore the docs »

View · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

A small app that determines a users favourite year in music by analyzing their liked songs in spotify.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• node
• pnpm
• spotify client id

Installation

1. Clone the repo

   git clone https://github.com/jakebottrall/your-favourite-year-in-music.git

2. CD into the repo

   cd your-favourite-year-in-music

3. Install packages

   pnpm install

4. Create a .env

   touch .env

5. Edit .env to include your spotify client id & callback uri, e.g.

   VITE_CLIENT_ID=your-client-id
   VITE_REDIRECT_URI=http://localhost:3000/callback

6. Run it

   pnpm dev

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Your Name - @jakebottrall

Project Link: https://github.com/jakebottrall/your-favourite-year-in-music

(back to top)

(back to top)