Skip to content

Commit

Permalink
Fetched template changes (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
spietras authored Oct 19, 2024
1 parent 36655a1 commit 9619600
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 31 deletions.
10 changes: 5 additions & 5 deletions .copier-answers.yaml
Original file line number Diff line number Diff line change
@@ -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
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

<div align="center">

[![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)

</div>

Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -129,37 +129,37 @@ 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
```

## 🐋 `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:

```sh
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

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,
Expand All @@ -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).
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
<h1 align="center">webfuse app</h1>
<h1 align="center">webfuse</h1>

<div align="center">

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)

</div>

---

## 💡 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).
6 changes: 3 additions & 3 deletions docs/docs/01-Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 5 additions & 5 deletions docs/docusaurus.config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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}`,
Expand Down Expand Up @@ -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",
Expand Down

0 comments on commit 9619600

Please sign in to comment.