Fela Maslen bf664f7816 fix: set API port by default on development to 3002 5 лет назад
..
public 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
src 5a156bb8d4 feat: request async callback hook 5 лет назад
.env.example bf664f7816 fix: set API port by default on development to 3002 5 лет назад
.env.test 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
.eslintrc.js 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
.gitignore 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
.prettierrc.js 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
README.md 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
package.json 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
tsconfig.json 6ae2b251e3 Refactor/project structure (#3) 5 лет назад
yarn.lock 6ae2b251e3 Refactor/project structure (#3) 5 лет назад

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.