arisgk / music-library-web

Playground music library web application

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Music Library Web Application

Playground project implementing a music library web app. Built with ReactJS and Redux. Material-UI components are used to implement Google's Material Design.

This project was bootstrapped with Create React App, so its docs could be helpful for development.

Features

  • Simple playlist and controls interface
  • Real-time notifications for what other people are listening (using WebSockets)

Possible Extensions

  • Volume control
  • Interactive song time progress bar
  • Artists & albums interfaces
  • User profile & preferences

Quick Start

Prerequisites

Define an .env file at the root directory of the project containing all the environment variables needed. The following environment variables are required:

  • REACT_APP_API_URL - The backend RESTful API URL
  • REACT_APP_SOCKET_SERVER_URL - The backend Websockets server URL.
  • NODE_PATH=src/ to resolve relative paths to src/ in your code.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Jest is used for test running and assertions. Enzyme is used for Jest snapshots shallow rendering.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Code Style

Prettier and ESLint with Airbnb style guide.

About

Playground music library web application


Languages

Language:JavaScript 96.3%Language:HTML 3.6%Language:Shell 0.1%