Fela Maslen 30bad0d2ff feat: queue view hace 5 años
..
public 6ae2b251e3 Refactor/project structure (#3) hace 5 años
src 30bad0d2ff feat: queue view hace 5 años
.env.example a958d33941 feat: skip to next / previous song hace 5 años
.env.test 6ae2b251e3 Refactor/project structure (#3) hace 5 años
.eslintrc.js 273b46c124 chore: removed deprecated package hace 5 años
.gitignore 6ae2b251e3 Refactor/project structure (#3) hace 5 años
.prettierrc.js 6ae2b251e3 Refactor/project structure (#3) hace 5 años
README.md 6ae2b251e3 Refactor/project structure (#3) hace 5 años
package.json 273b46c124 chore: removed deprecated package hace 5 años
tsconfig.json 6ae2b251e3 Refactor/project structure (#3) hace 5 años
yarn.lock 273b46c124 chore: removed deprecated package hace 5 años

README.md

gmus-web

This is a frontend web app for use with the gmus backend.

Scripts

yarn start

Runs the app in the development mode.

yarn test

Runs tests

yarn build

Builds app

Architecture

Global app

This is the main part of the app. It is responsible for handling:

  • Global state such as which song is playing, and the current time
  • Connections to the API, through a websocket
  • Sharing state with other clients, and responding to updates from the API
  • Playing music, through an HTML element
  • UI

    This is the part of the app which implements user interaction. It is responsible for handling:

    • User input, to decide which actions to take
    • Display, to let the user know the state of things

    UIs follow a common model and are built into separate bundles, then lazily loaded.

    The following UIs are implemented:

    cmus

    This is based heavily on the cmus ncurses-based music player, and is essentially a web-based client with vim-like bindings for navigation.