Fela Maslen
cb56f31d88
refactor: renamed backend and web client to gmus-backend and gmus-web
|
%!s(int64=5) %!d(string=hai) anos | |
|---|---|---|
| .. | ||
| public | %!s(int64=5) %!d(string=hai) anos | |
| src | %!s(int64=5) %!d(string=hai) anos | |
| .env.example | %!s(int64=5) %!d(string=hai) anos | |
| .env.test | %!s(int64=5) %!d(string=hai) anos | |
| .eslintrc.js | %!s(int64=5) %!d(string=hai) anos | |
| .gitignore | %!s(int64=5) %!d(string=hai) anos | |
| .prettierrc.js | %!s(int64=5) %!d(string=hai) anos | |
| README.md | %!s(int64=5) %!d(string=hai) anos | |
| package.json | %!s(int64=5) %!d(string=hai) anos | |
| tsconfig.json | %!s(int64=5) %!d(string=hai) anos | |
| yarn.lock | %!s(int64=5) %!d(string=hai) anos | |
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
- User input, to decide which actions to take
- Display, to let the user know the state of things
UI
This is the part of the app which implements user interaction. It is responsible for handling:
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.