diff --git a/.copier-answers.yaml b/.copier-answers.yaml index 8f6cf01..723c2ea 100644 --- a/.copier-answers.yaml +++ b/.copier-answers.yaml @@ -1,16 +1,16 @@ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY -_commit: 0.1.1 +_commit: 0.2.0 _src_path: gh:radio-aktywne/template-app-next accountname: radio-aktywne appname: webfuse -description: Audio streaming with Liquidsoap web UI ๐Ÿงผ +description: Broadcast composing app ๐Ÿงผ docs: true -docsurl: https://radio-aktywne.github.io/app-webfuse +docsurl: https://radio-aktywne.github.io/webfuse envprefix: WEBFUSE imagename: apps/webfuse keyprefix: webfuse port: 12000 registry: true releases: true -reponame: app-webfuse -repourl: https://github.com/radio-aktywne/app-webfuse +reponame: webfuse +repourl: https://github.com/radio-aktywne/webfuse diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6eba479..2a8ed86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,13 +11,13 @@ The whole development environment will be running inside a container. If you open the project in `Visual Studio Code`, you should be prompted to reopen the project in a `Dev Container`. You can also click -[here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/app-webfuse) +[here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/webfuse) or on the badge below to tell `Visual Studio Code` to open the project in a `Dev Container`.
-[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/app-webfuse) +[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/webfuse)
@@ -100,7 +100,7 @@ Here are the most common ones, using `Task`: Linting is automatically run on every pull request and push to the `main` branch. You can find the `GitHub Actions` workflow that does this in -[`.github/workflows/lint.yaml`](https://github.com/radio-aktywne/app-webfuse/blob/main/.github/workflows/lint.yaml). +[`.github/workflows/lint.yaml`](https://github.com/radio-aktywne/webfuse/blob/main/.github/workflows/lint.yaml). If you use the `Dev Container` setup, you will have the `Trunk` extension installed in `Visual Studio Code`. @@ -129,7 +129,7 @@ task update ## โ–ถ๏ธ Running -To run the application, you can use the following command: +To run the app, you can use the following command: ```sh task run @@ -137,7 +137,7 @@ task run ## ๐Ÿ‹ `Docker` -You can also run the application in a [`Docker`](https://www.docker.com) container. +You can also run the app in a [`Docker`](https://www.docker.com) container. To do this, just run the following command: @@ -145,7 +145,7 @@ To do this, just run the following command: task docker ``` -This will build a `Docker` image and run the application in a container. +This will build a `Docker` image and run the app in a container. ## ๐Ÿ“ฆ Releases @@ -153,13 +153,13 @@ Every time you create a new release on `GitHub`, a `GitHub Actions` workflow will automatically build and publish a new `Docker` image to the `GitHub Container Registry`. You can find the `GitHub Actions` workflow that does this in -[`.github/workflows/registry.yaml`](https://github.com/radio-aktywne/app-webfuse/blob/main/.github/workflows/registry.yaml). +[`.github/workflows/registry.yaml`](https://github.com/radio-aktywne/webfuse/blob/main/.github/workflows/registry.yaml). ## ๐Ÿ“„ Docs This project uses [`Docusaurus`](https://docusaurus.io) to generate documentation. The documentation is hosted on `GitHub Pages` and can be found -[here](https://radio-aktywne.github.io/app-webfuse). +[here](https://radio-aktywne.github.io/webfuse). All the documentation files are located in the `docs` directory. To build and serve the documentation locally, @@ -174,4 +174,4 @@ This will start a local server that will serve the documentation. The documentation is automatically built and deployed to `GitHub Pages` whenever a commit is pushed to the `main` branch. You can find the `GitHub Actions` workflow that does this in -[`.github/workflows/docs.yaml`](https://github.com/radio-aktywne/app-webfuse/blob/main/.github/workflows/docs.yaml). +[`.github/workflows/docs.yaml`](https://github.com/radio-aktywne/webfuse/blob/main/.github/workflows/docs.yaml). diff --git a/README.md b/README.md index 240f313..f7bcbb8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -

webfuse app

+

webfuse

-Audio streaming with Liquidsoap web UI ๐Ÿงผ +Broadcast composing app ๐Ÿงผ -[![Lint](https://github.com/radio-aktywne/app-webfuse/actions/workflows/lint.yaml/badge.svg)](https://github.com/radio-aktywne/app-webfuse/actions/workflows/lint.yaml) -[![Image](https://github.com/radio-aktywne/app-webfuse/actions/workflows/image.yaml/badge.svg)](https://github.com/radio-aktywne/app-webfuse/actions/workflows/image.yaml) -[![Registry](https://github.com/radio-aktywne/app-webfuse/actions/workflows/registry.yaml/badge.svg)](https://github.com/radio-aktywne/app-webfuse/actions/workflows/registry.yaml) -[![Docs](https://github.com/radio-aktywne/app-webfuse/actions/workflows/docs.yaml/badge.svg)](https://github.com/radio-aktywne/app-webfuse/actions/workflows/docs.yaml) +[![Lint](https://github.com/radio-aktywne/webfuse/actions/workflows/lint.yaml/badge.svg)](https://github.com/radio-aktywne/webfuse/actions/workflows/lint.yaml) +[![Image](https://github.com/radio-aktywne/webfuse/actions/workflows/image.yaml/badge.svg)](https://github.com/radio-aktywne/webfuse/actions/workflows/image.yaml) +[![Registry](https://github.com/radio-aktywne/webfuse/actions/workflows/registry.yaml/badge.svg)](https://github.com/radio-aktywne/webfuse/actions/workflows/registry.yaml) +[![Docs](https://github.com/radio-aktywne/webfuse/actions/workflows/docs.yaml/badge.svg)](https://github.com/radio-aktywne/webfuse/actions/workflows/docs.yaml)
@@ -15,14 +15,14 @@ Audio streaming with Liquidsoap web UI ๐Ÿงผ ## ๐Ÿ’ก About -`webfuse` is a web application for managing audio streaming with Liquidsoap. +`webfuse` is a web app for broadcast composing with Liquidsoap. ## ๐Ÿ“„ Further Reading More in-depth documentation can be found -[here](https://radio-aktywne.github.io/app-webfuse). +[here](https://radio-aktywne.github.io/webfuse). ## ๐Ÿ’ป Development Read more about how to develop the project -[here](https://github.com/radio-aktywne/app-webfuse/blob/main/CONTRIBUTING.md). +[here](https://github.com/radio-aktywne/webfuse/blob/main/CONTRIBUTING.md). diff --git a/docs/docs/01-Index.md b/docs/docs/01-Index.md index ba91ade..86569d5 100644 --- a/docs/docs/01-Index.md +++ b/docs/docs/01-Index.md @@ -3,10 +3,10 @@ slug: / title: Index --- -# webfuse app +# webfuse -Audio streaming with Liquidsoap web UI ๐Ÿงผ +Broadcast composing app ๐Ÿงผ ## ๐Ÿ’ก About -`webfuse` is a web application for managing audio streaming with Liquidsoap. +`webfuse` is a web app for broadcast composing with Liquidsoap. diff --git a/docs/docusaurus.config.mts b/docs/docusaurus.config.mts index 95e83d7..a41de10 100644 --- a/docs/docusaurus.config.mts +++ b/docs/docusaurus.config.mts @@ -2,10 +2,10 @@ import type * as Preset from "@docusaurus/preset-classic"; import type { Config } from "@docusaurus/types"; import { themes } from "prism-react-renderer"; -const url = new URL("https://radio-aktywne.github.io/app-webfuse"); +const url = new URL("https://radio-aktywne.github.io/webfuse"); const config: Config = { - title: "webfuse app docs", + title: "webfuse docs", favicon: "favicon.svg?v=1", url: `${url.protocol}//${url.host}`, @@ -41,14 +41,14 @@ const config: Config = { themeConfig: { navbar: { - title: "webfuse app docs", + title: "webfuse docs", logo: { - alt: "webfuse app docs logo", + alt: "webfuse docs logo", src: "logo.svg?v=1", }, items: [ { - href: "https://github.com/radio-aktywne/app-webfuse", + href: "https://github.com/radio-aktywne/webfuse", position: "right", className: "header-github-link", "aria-label": "GitHub repository",