Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fetched template changes #3

Merged
merged 1 commit into from
Oct 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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: weblounge
description: Emission prerecordings web UI 📼
description: Broadcast prerecordings app 🛋️
docs: true
docsurl: https://radio-aktywne.github.io/app-weblounge
docsurl: https://radio-aktywne.github.io/weblounge
envprefix: WEBLOUNGE
imagename: apps/weblounge
keyprefix: weblounge
port: 39000
registry: true
releases: true
reponame: app-weblounge
repourl: https://github.com/radio-aktywne/app-weblounge
reponame: weblounge
repourl: https://github.com/radio-aktywne/weblounge
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-weblounge)
[here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/weblounge)
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-weblounge)
[![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/weblounge)

</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-weblounge/blob/main/.github/workflows/lint.yaml).
[`.github/workflows/lint.yaml`](https://github.com/radio-aktywne/weblounge/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-weblounge/blob/main/.github/workflows/registry.yaml).
[`.github/workflows/registry.yaml`](https://github.com/radio-aktywne/weblounge/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-weblounge).
[here](https://radio-aktywne.github.io/weblounge).
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-weblounge/blob/main/.github/workflows/docs.yaml).
[`.github/workflows/docs.yaml`](https://github.com/radio-aktywne/weblounge/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">weblounge app</h1>
<h1 align="center">weblounge</h1>

<div align="center">

Emission prerecordings web UI 📼
Broadcast prerecordings app 🛋️

[![Lint](https://github.com/radio-aktywne/app-weblounge/actions/workflows/lint.yaml/badge.svg)](https://github.com/radio-aktywne/app-weblounge/actions/workflows/lint.yaml)
[![Image](https://github.com/radio-aktywne/app-weblounge/actions/workflows/image.yaml/badge.svg)](https://github.com/radio-aktywne/app-weblounge/actions/workflows/image.yaml)
[![Registry](https://github.com/radio-aktywne/app-weblounge/actions/workflows/registry.yaml/badge.svg)](https://github.com/radio-aktywne/app-weblounge/actions/workflows/registry.yaml)
[![Docs](https://github.com/radio-aktywne/app-weblounge/actions/workflows/docs.yaml/badge.svg)](https://github.com/radio-aktywne/app-weblounge/actions/workflows/docs.yaml)
[![Lint](https://github.com/radio-aktywne/weblounge/actions/workflows/lint.yaml/badge.svg)](https://github.com/radio-aktywne/weblounge/actions/workflows/lint.yaml)
[![Image](https://github.com/radio-aktywne/weblounge/actions/workflows/image.yaml/badge.svg)](https://github.com/radio-aktywne/weblounge/actions/workflows/image.yaml)
[![Registry](https://github.com/radio-aktywne/weblounge/actions/workflows/registry.yaml/badge.svg)](https://github.com/radio-aktywne/weblounge/actions/workflows/registry.yaml)
[![Docs](https://github.com/radio-aktywne/weblounge/actions/workflows/docs.yaml/badge.svg)](https://github.com/radio-aktywne/weblounge/actions/workflows/docs.yaml)

</div>

---

## 💡 About

`weblounge` is a web application for managing prerecorded broadcasts.
`weblounge` is a web app for managing prerecorded broadcasts.

## 📄 Further Reading

More in-depth documentation can be found
[here](https://radio-aktywne.github.io/app-weblounge).
[here](https://radio-aktywne.github.io/weblounge).

## 💻 Development

Read more about how to develop the project
[here](https://github.com/radio-aktywne/app-weblounge/blob/main/CONTRIBUTING.md).
[here](https://github.com/radio-aktywne/weblounge/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
---

# weblounge app
# weblounge

Emission prerecordings web UI 📼
Broadcast prerecordings app 🛋️

## 💡 About

`weblounge` is a web application for managing prerecorded broadcasts.
`weblounge` is a web app for managing prerecorded broadcasts.
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-weblounge");
const url = new URL("https://radio-aktywne.github.io/weblounge");

const config: Config = {
title: "weblounge app docs",
title: "weblounge 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: "weblounge app docs",
title: "weblounge docs",
logo: {
alt: "weblounge app docs logo",
alt: "weblounge docs logo",
src: "logo.svg?v=1",
},
items: [
{
href: "https://github.com/radio-aktywne/app-weblounge",
href: "https://github.com/radio-aktywne/weblounge",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
Expand Down