Skip to content

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-heimbuch committed Jan 3, 2025
1 parent 078a8aa commit bc30fbd
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 93 deletions.
54 changes: 15 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Podlove UI

> Mono Repo for all UI Related Podlove Projects
> Home of Podlove Web Player, Podlove Subscribe Button and Podlove Lux
## Getting Started

### For Contribution

1. Make sure you have Node 10+ and [lerna](https://lerna.js.org/) installed
1. Make sure you have [devbox installed](https://www.jetify.com/docs/devbox/quickstart/)
2. Fork this repository
3. Run `npm install` to setup the workspace
4. Run npm scripts for development (e.g. `npm run dev:web-player`)
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

Expand All @@ -30,15 +31,15 @@ Note: These are recommended and well supported libraries. The usage within each

### [@podlove/player](apps/player/README.md)

Core Podlove Player State Bound Components. Building blocks with state bindings to create the web player
Podlove Web Player, including building blocks with state bindings and default templates.

### [@podlove/subscribe-button](apps/subscribe-button/README.md)
### [@podlove/page](apps/page/README.md)

Podlove Lux, frontend for RSS feeds with a sticky player and powerfull search.

Embedded Subscribe Button with client detection:
### [@podlove/subscribe-button](apps/subscribe-button/README.md)

- Podcatcher Services
- Podcatcher Clients
- Install and RSS Feed Endcard
Embedded Subscribe Button with client detection.

## Packages

Expand Down Expand Up @@ -88,42 +89,17 @@ Collection of helper utils for dealing with time, transforming chapters accordin

Documentation for Podlove Web Player

## Build Environment

Used CI: [DroneCI](https://cloud.drone.io/podlove/podlove-ui) with the following [pipelines](.drone.yml):

- `apps/player`
- `apps/web-player`
- `apps/subscribe-button`
- `apps/components`
- `packages/player-actions`
- `packages/player-sagas`
- `packages/player-state`
- `packages/player-utils`
- `packages/clients`
- `docs/web-player`

Steps:

- `lint`
- `test`
- `build`
- `integration`
- `release`

## 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. Create a release branch from the `master` or `support` branch
2. Run the following lerna command in the release branch: `lerna version --no-git-tag-version`
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. Create a PR against master/support branch and merge it if the release/review was successfull
4. Tag the master/support commit with the release version (e.g. `v5.0.2`)
5. Create an integration branch by branching from develop and merge master into the integration branch
6. Create a PR with develop as the target branch and merge it if the release/review was successfull
3. Push the release commit and tag to Github
4. Wait for the release to be published

### Join the conversation

Expand Down
55 changes: 1 addition & 54 deletions apps/page/README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1 @@
# Astro Starter Kit: Basics

```sh
npm create astro@latest -- --template basics
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)

## 🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |

## 👀 Want to learn more?

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
# Podlove Page (Lux)

0 comments on commit bc30fbd

Please sign in to comment.