https://github.com/podlove/podlove-ui
Monorepo for all UI related projects like Web Player and Subscribe Button
https://github.com/podlove/podlove-ui
Last synced: about 1 year ago
JSON representation
Monorepo for all UI related projects like Web Player and Subscribe Button
- Host: GitHub
- URL: https://github.com/podlove/podlove-ui
- Owner: podlove
- License: mit
- Created: 2019-03-17T19:32:57.000Z (about 7 years ago)
- Default Branch: development
- Last Pushed: 2024-10-27T09:46:01.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:43:01.106Z (over 1 year ago)
- Language: TypeScript
- Size: 128 MB
- Stars: 83
- Watchers: 5
- Forks: 33
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-broadcasting - Podlove Web Player - Podcast-optimized, HTML5-based video and audio player. (Podcasting)
README
# Podlove UI
> Home of Podlove Web Player, Podlove Subscribe Button and Podlove Lux
## Getting Started
### For Contribution
1. Make sure you have [devbox installed](https://www.jetify.com/docs/devbox/quickstart/)
2. Fork this repository
3. Run `devbox install` to setup the workspace
4. Run `devbox run pnpm install` to install the dependencies
4. Run scripts for development (e.g. `devbox run pnpm start`)
### For Usage
This mono repo creates a set of different packages within the `@podlove` NPM organization. Once released you can use each package by simply installing it as a dependency.
## Used Libraries and Frameworks
- Workspace Management: [Lerna](https://lerna.js.org/)
- Bundling: [Vite](https://vitejs.dev/)
- View Renderer: [Vue](https://vuejs.org/)
- Statemanagement: [Redux](https://redux.js.org/)
- Styling: [Tailwind](https://tailwindcss.com/)
- Testing: [Vitest](https://vitest.dev/) and [Cypress](https://www.cypress.io/)
Note: These are recommended and well supported libraries. The usage within each application/package may vary.
## Applications
### [@podlove/player](apps/player/README.md)
Podlove Web Player, including building blocks with state bindings and default templates.
### [@podlove/page](apps/page/README.md)
Podlove Lux, frontend for RSS feeds with a sticky player and powerfull search.
### [@podlove/subscribe-button](apps/subscribe-button/README.md)
Embedded Subscribe Button with client detection.
## Packages
### [@podlove/button-actions](packages/button/actions/README.md)
Button actions API, types and events that are used in state and subscribe-button.
### [@podlove/button-config](packages/button/config/README.md)
Parser for subscribe-button configuration.
### [@podlove/button-state](packages/button/state/README.md)
Subscribe Button reducers and selectors for creating and maintaining the subscribe-button state.
### [@podlove/clients](packages/clients/README.md)
Library containing up to date podcatcher clients and uri schema.
### [@podlove/components](packages/components/README.md)
Shared Representational Podlove Components. Stateless components that dispatch podlove events.
### [@podlove/player-actions](packages/player/actions/README.md)
Player actions API, types and events that are used in state, sagas and player.
### [@podlove/player-config](packages/player/config/README.md)
Parser for player configuration.
### [@podlove/player-sagas](packages/player/sagas/README.md)
Player Side Effects Management, abstracting Player eventing and lifecycle.
### [@podlove/player-state](packages/player/state/README.md)
Player reducers and selectors for creating and maintaining the player state.
### [@podlove/utils](packages/utils/README.md)
Collection of helper utils for dealing with time, transforming chapters according to the Simple Chapters Specification or making requests.
## Docs
### [web-player](https://docs.podlove.org/podlove-web-player)
Documentation for Podlove Web Player
## Releasing
Podlove Web Player follows the git flow convention with support branches. Please read the [documentation to follow this pattern](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) if you want to contribute.
To create a release you have to:
1. MErge your changes to a release branch (e.g. `master`)
2. Run `devbox run pnpm run version` to start the release process
- Select a major/minor/patch/custom version (please see [semantic versioning documentation](https://semver.org))
3. Push the release commit and tag to Github
4. Wait for the release to be published
### Join the conversation
Become a part of the
* **Podlove community** [community.podlove.org](https://community.podlove.org/), or discuss your
* **Web Player** topics or questions on [community.podlove.org/c/podlove-web-player](https://community.podlove.org/c/podlove-web-player).
If you're interested in discussing podcasting topics in general, please visit [sendegate.de](https://sendegate.de/).
### Podlove Docs
* **Podlove Project:** [podlove.github.com](http://podlove.github.com)
* **Web Player:** [docs.podlove.org/podlove-web-player](http://docs.podlove.org/podlove-web-player/)
### Report an issue
If you encounter a specific problem using the Podlove Web Player that you think is a bug, or you see a problem in the documentation, you can report the issue here:
[github.com/podlove/ui/issues](https://github.com/podlove/ui/issues)
Also, if you have ideas for new features for player, please submit them as a [Github issue](https://github.com/podlove/ui/issues).
Have a look on the Github project to watch the status and progress of your issues:
[github.com/podlove/ui/projects](https://github.com/podlove/ui/projects/1)
## Support
### CDN sponsored by
### Cross Browser Testing powered by
