Skip to content

m-kupiec/music-app

Repository files navigation

Spotify Client

A TypeScript and React web application leveraging the Spotify Web API for music library management. For the latest development updates, as well as detailed requirements and acceptance criteria, refer to the project board.

Quick Start

  1. Log in to Spotify for Developers and open your Dashboard. Create a new app by following these instructions.
  2. Clone or download this repository.
  3. Navigate to the project directory and run npm install to install dependencies.
  4. Open src/config.ts and add your Spotify app's Client ID and Redirect URI, which you can find on your application's Dashboard page.
  5. Start the development server with npm run dev.

Installation

Registering Your App on Spotify

  1. Log in to Spotify for Developers and navigate to your Dashboard.
  2. Create a new app by following the steps in Spotify's app creation guide.

Installing Dependencies

Note: The projects requires Node.js version 18+ or 20+.

After cloning or downloading the repository, navigate to the project directory and install the npm packages:

npm install

Configuring the Application

Update src/config.ts with your Spotify Client ID and Redirect URI from the Spotify Dashboard.

Alternatively, if you prefer to keep appConfig.spotifyAuth.clientId as import.meta.env.VITE_CLIENT_ID, you can create a .env.local file in the project's root directory with the following content:

VITE_CLIENT_ID=<your-client-id>

Ensure that the port in appConfig.spotifyAuth.redirectUrl matches the port used by Vite on your local machine (5173 by default).

Usage

Starting the Development Server

Run Vite's development server:

npm run dev

Previewing the Production Build

To preview the production build locally (after running the build script):

npm run preview

Building the Project

To run the TypeScript compiler and build the project with Vite:

npm run build

License

This project is licensed under the MIT License.

About

Web application (TypeScript, React) leveraging the Spotify Web API for music library management

Topics

Resources

License

Stars

Watchers

Forks