Merge pull request #802 from ajnart/dev

v0.12.0

.deepsource.toml

@@ -0,0 +1,10 @@
+version = 1
+
+[[analyzers]]
+name = "javascript"
+
+  [analyzers.meta]
+  plugins = ["react"]
+
+[[transformers]]
+name = "prettier"

.eslintrc.js

@@ -2,12 +2,12 @@ module.exports = {
   extends: [
     'mantine',
     'plugin:@next/next/recommended',
-    'plugin:jest/recommended',
     'eslint:recommended',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
+    'plugin:vitest/recommended',
   ],
-  plugins: ['testing-library', 'jest', 'react-hooks', 'react', 'unused-imports'],
+  plugins: ['testing-library', 'react-hooks', 'react', 'unused-imports', 'vitest'],
   overrides: [
     {
       files: ['**/?(*.)+(spec|test).[jt]s?(x)'],
@@ -31,5 +31,12 @@ module.exports = {
     '@typescript-eslint/no-non-null-assertion': 'off',
     'no-continue': 'off',
     'linebreak-style': 0,
+    'vitest/max-nested-describe': [
+      'error',
+      {
+        max: 3,
+      },
+    ],
+    'testing-library/no-node-access': ['error', { allowContainerFirstChild: true }],
   },
 };

.github/ISSUE_TEMPLATE/bug.yml

@@ -32,8 +32,15 @@ body:
   - type: textarea
     id: logs
     attributes:
-      label: Additional info
-      description: Logs? Screenshots? More info?
+      label: Logs
+      description: Provide your Homarr logs so we can investigate what's going on
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: Screenshots? More info?
     validations:
       required: false
   - type: checkboxes
@@ -42,9 +49,11 @@ body:
       label: Please tick the boxes
       description: Before submitting, please ensure that
       options:
-        - label: You've read the [docs](https://github.com/ajnart/homarr#readme)
+        - label: I confirm that I attached the proper logs
+          required: true
+        - label: I've read the [docs](https://github.com/ajnart/homarr#readme)
           required: true
-        - label: You've checked for [duplicate issues](https://github.com/ajnart/homarr/issues)
+        - label: I've checked for [duplicate issues](https://github.com/ajnart/homarr/issues)
           required: true
-        - label: You've tried to debug yourself
+        - label: I've tried to debug myself
           required: true

.github/workflows/docker_dev.yml

@@ -24,11 +24,14 @@ env:
   REGISTRY: ghcr.io
   # github.repository as <account>/<repo>
   IMAGE_NAME: ${{ github.repository }}
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+
 
 jobs:
   # Push image to GitHub Packages.
   # See also https://docs.docker.com/docker-hub/builds/
-  yarn_install_and_build:
+  yarn_install_and_build_dev:
     runs-on: ubuntu-latest
     permissions:
       packages: write
@@ -67,7 +70,7 @@ jobs:
 
       - run: yarn install --immutable
 
-      - run: yarn build
+      - run: yarn turbo build
 
       - name: Docker meta
         if: github.event_name != 'pull_request'

.gitignore

@@ -25,13 +25,15 @@ yarn-debug.log*
 yarn-error.log*
 
 # local env files
+.env
 .env.local
 .env.development.local
 .env.test.local
 .env.production.local
 
 # vercel
 .vercel
+.turbo
 *.tsbuildinfo
 
 # storybook
@@ -46,4 +48,7 @@ data/configs
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
-!.yarn/versions
+!.yarn/versions
+
+#envfiles
+.env

CONTRIBUTING.md

@@ -104,3 +104,11 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/ajnart
 Homarr uses [GitMoji](https://gitmoji.dev/).
 We would appreciate it if everyone keeps their commit messages withing these rulings.
 
+### Tests
+
+> Components should be tested using unit tests. A unit is the smallest isolated part of the component. Unit tests must not have any dependencies and must be isolated.
+
+- Place testfiles directly at the root of the unit
+- Only test a single unit of work inside a unit test
+- You may test multiple units inside one test file
+- Testnames do not begin with ``should`` or the unit name

README.md

@@ -1,23 +1,21 @@
 
 <!-- Project Title -->
-<picture id="banner">
-<img src="./docs/banner.png" />
-</picture>
+![Banner](docs/banner.png)
 
 <!-- Badges -->
 <p align="center">
 <img src="https://img.shields.io/github/stars/ajnart/homarr?label=%E2%AD%90%20Stars&style=flat-square?branch=master&kill_cache=1%22">
 <a href="https://github.com/ajnart/homarr/releases/latest">
-  <img alt="Latest Release (Semver)" src="https://img.shields.io/github/v/release/ajnart/homarr?label=%F0%9F%9A%80%20Release">
+  <img alt="Latest Release (Semver)" src="https://img.shields.io/github/v/release/ajnart/homarr?label=%F0%9F%9A%80%20Release">
 </a>
 <a href="https://github.com/ajnart/homarr/actions/workflows/docker.yml">
-  <img title="Docker CI Status" src="https://github.com/ajnart/homarr/actions/workflows/docker.yml/badge.svg" alt="CI Status">
+  <img title="Docker CI Status" src="https://github.com/ajnart/homarr/actions/workflows/docker.yml/badge.svg" alt="CI Status">
 </a>
 <a href=https://crowdin.com/project/homarr>
 <img title="Translations" src="https://badges.crowdin.net/homarr/localized.svg" />
 </a>
 <a href="https://discord.gg/aCsmEV5RgA">
-  <img title="Discord" src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield">
+  <img title="Discord" src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield">
 </a>
 </p>
 
@@ -38,43 +36,38 @@
   </a>
 </p>
 
-
 Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips. With Homarr, you can access and control everything in one convenient location. Homarr seamlessly integrates with the apps you've added, providing you with valuable information and giving you complete control. Installation is a breeze, and Homarr supports a wide range of deployment methods.
 
 <br/>
 <br/>
 
-<picture id="features">
-<img src="docs/section-features.png" />
-</picture>
+![Features Section](docs/section-features.png)
 
-- 🖌️ Highly customizeable with extensive drag and drop grid system
+- 🖌️ Highly customizable with an extensive drag and drop grid system
 - ✨ Integrates seamlessly with your favorite self-hosted applications
-- 📌 Easy and fast app management - no yaml involved
-- 🙊 Advanced secrets management system for enhanced security
+- 📌 Easy and fast app management - no YAML involved
+- 🙊 Advanced secrets' management system for enhanced security
 - 📄 Detailed documentation and active community
-- 🔍 Search though the web or supported integrations in an instant
-- 🏴󠁧󠁢󠁮󠁩󠁲󠁿 Monitor your application with a built in status system
+- 🔍 Search through the web or supported integrations in an instant
+- 🏴󠁧󠁢󠁮󠁩󠁲󠁿 Monitor your application with a built-in status system
 - 🦞 Comprehensive built-in icon picker with over 1000 icons
-- 🐳 Easy deployment with Docker, Unraid, Synology
-- 🚀 Comatible with any major consumer hardware (x86, Rasperry Pi, ...)
+- 🐳 Easy deployment with Docker, unRAID, Synology
+- 🚀 Compatible with any major consumer hardware (x86, Raspberry Pi, ...)
 - 💵 Free and Open-Source - your data stays on your device
 
 <br/>
 <br/>
 
-<picture id="widgets-and-integrations">
-<img src="docs/section-widgets-and-integrations.png" />
-</picture>
+![Widgets & Integrations Section](docs/section-widgets-and-integrations.png)
 
-Homarr has a [built in collection of widgets and integrations](https://homarr.dev/docs/integrations/) , that connect to your applications and enable you to control them directly from the dashboard.
-Each widget and integration has a comprehensive documentation for your confort.
+Homarr has a [built-in collection of widgets and integrations](https://homarr.dev/docs/integrations/), that connect to your applications and enable you to control them directly from the dashboard.
+Each widget and integration has a comprehensive documentation for your comfort.
 Homarr will integrate with the following applications of yours:
 
 - 📥 Torrent clients
-  - [Delguge](https://homarr.dev/docs/integrations/#deluge)
+  - [Deluge](https://homarr.dev/docs/integrations/#deluge)
   - [Transmission](https://homarr.dev/docs/integrations/#transmission)
-  - [qBittorrent](https://homarr.dev/docs/integrations/#qbittorrent-integration)
+  - [qBittorent](https://homarr.dev/docs/integrations/#qbittorrent-integration)
 - 📥 Usenet clients
   - [SABnzbd](https://homarr.dev/docs/integrations/#sabnzbd)
   - [NZBGet](https://homarr.dev/docs/integrations/#nzbget)
@@ -94,21 +87,17 @@ We're constantly adding new integrations and widgets, which will enhance your ex
 <br/>
 <br/>
 
-<picture id="preview">
-<img src="docs/section-preview.png" />
-</picture>
+![Preview Section](docs/section-preview.png)
 
 https://user-images.githubusercontent.com/30572287/217098893-5880e7de-13d0-42c5-b505-f7921593396f.mp4
 
 <br/>
 <br/>
 
-<picture id="installation">
-<img src="docs/section-installation.png" />
-</picture>
+![Installation Section](docs/section-installation.png)
 
 There are many different ways, how Homarr can be installed.
-Since we are developing Homarr very frequently, we recommend to read our official installation guides:
+Since we are developing Homarr very frequently, we recommend reading our official installation guides:
 
 <a href="https://homarr.dev/docs/introduction/installation">
   <img src="docs/installation-button.png" width="200" />
@@ -117,19 +106,19 @@ Since we are developing Homarr very frequently, we recommend to read our officia
 <br/>
 <br/>
 
-<picture id="contribute">
-<img src="docs/section-contribute.png" />
-</picture>
+![Contribute Section](docs/section-contribute.png)
 Homarr is maintained by motivated developers in their free-time.
 We work for fun and learning on this project.
 
-Hence, we're glad for all help and support we can get.
-Altough a donation is apprechiated, there are also other ways you can support us.
+Hence, we're glad for all the help and support we can get.
+Although a donation is appreciated, there are other ways you can support us.
 
-[_![](https://cdn.ko-fi.com/cdn/kofi3.png?v=3)_](https://ko-fi.com/ajnart)
+<a href="https://ko-fi.com/ajnart">
+  <img src="https://cdn.ko-fi.com/cdn/kofi3.png?v=3" width="200" />
+</a>
 
-You can also support us [translating the entire project in as many languages as possible](https://homarr.dev/docs/community/translations) or contribute directly to the code or documentation.
+You can also support us [translating the entire project in as many languages as possible,](https://homarr.dev/docs/community/translations) or contribute directly to the code or documentation.
 
 **Please read our [Contribution Guidelines](/CONTRIBUTING.md)**
 
-All contributions, regardless of their size or scope, are welcome and highly apprechiated! Thank you ❤️
+All contributions, regardless of their size or scope, are welcome and highly appreciated! Thank you ❤️