Actualizar

.eslintrc.js

@@ -1,5 +1,12 @@
 module.exports = {
-  extends: ["eslint:recommended", "plugin:react-hooks/recommended"],
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
   rules: {
     maxClassesPerFile: 0,
     maxLineLength: 0,

.github/workflows/main.yml

@@ -0,0 +1,106 @@
+name: Tests and push apps
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+
+  style:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@master
+
+    - name: Setup node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16'
+
+    - name: Install dependencies
+      uses: borales/actions-yarn@v3.0.0
+      with:
+        cmd: install
+
+    - name: Check code formatting
+      uses: borales/actions-yarn@v3.0.0
+      with:
+        cmd: prettier --check
+
+    - name: Check code linting
+      uses: borales/actions-yarn@v3.0.0
+      with:
+        cmd: lint
+
+  dashboard:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@master
+
+    - name: Setup node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16'
+
+    - name: Install dependencies
+      uses: borales/actions-yarn@v3.0.0
+      with:
+        cmd: install
+
+    - name: Check code typing
+      uses: borales/actions-yarn@v3.0.0
+      with:
+        cmd: typecheck
+
+    - name: Run unit tests
+      uses: borales/actions-yarn@v3.0.0
+      with:
+        cmd: test --coverage
+
+    - name: Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
+        verbose: true
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [style, dashboard]
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@master
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v1
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Login to DockerHub
+      uses: docker/login-action@v1 
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v1 
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and push
+      uses: docker/build-push-action@v2
+      with:
+        push: true
+        platforms: linux/amd64,linux/arm64/v8,linux/arm/v7
+        tags: |
+          phntxx/dashboard:latest
+          ghcr.io/phntxx/dashboard:latest

CONTRIBUTING.md

@@ -1,6 +1,15 @@
 # Contributing to this repository
 
+Thank you for wanting to contribute to dashboard!
+
 There are a few things to keep in mind when contributing:
 
 - We're using Prettier, so make sure to either format your code using `yarn prettier --write`, or by installing an extension for your editor to auto-format everything.
 - We're using the React testing library for testing and CircleCI for CI/CD. Please ensure that the tests pass with your contribution, either by adding sufficient test coverage to your contribution or by modifying existing tests for sufficient coverage (that is if your contribution modifies existing code).
+
+In summary, please make sure the following two commands run without issue before creating your PR:
+
+```sh
+yarn prettier
+yarn test
+```

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Bastian Meissner
+Copyright (c) 2022 Bastian Meissner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,10 +1,8 @@
 # Dashboard
 
-[![CircleCI][shield-circleci]][circleci]
 [![Docker Cloud Build Status][shield-docker]][docker]
 [![Docker Image Size (latest)][shield-docker-image]][docker]
 [![codecov][shield-codecov]][codecov]
-[![Dependencies][shield-deps]][repo]
 [![GitHub license][shield-license]][license]
 
 ![Alt text](/screenshot.png?raw=true "screenshot")
@@ -28,15 +26,17 @@ The recommended way of installation is using [Docker](https://docker.com). You c
 
 The Docker image is built on top of [this image](https://github.com/ratisbona-coding/nginx-cloudflare-cache), as it's based on Nginx and also provides functionality to purge the Cloudflare cache every time the container restarts (though this functionality is entirely optional).
 
+The Docker image is available on both [DockerHub](docker) and the GitHub Container Repository (GHCR, see "packages").
+
 1. Using the Docker CLI:
 
 ```sh
 $ docker run -d \
   -e CLOUDFLARE_ZONE_ID=[OPTIONAL CLOUDFLARE V4 ZONE ID] \
   -e CLOUDFLARE_PURGE_TOKEN=[OPTIONAL CLOUDFLARE PURGE TOKEN] \
-  -v $(pwd)/data:/app/data
+  -v $(pwd)/data:/app/data \
   -p 8080:8080 \
-  --name dashboard \
+  --name=dashboard \
   phntxx/dashboard
 ```
 
@@ -71,6 +71,7 @@ $ yarn serve:production
 ```
 
 ### Manual install
+
 ```bash
 $ git clone https://github.com/phntxx/dashboard.git
 $ cd dashboard/
@@ -80,6 +81,7 @@ $ cp -R build/* .
 ```
 
 #### `/etc/nginx/conf.d/dashboard.conf`
+
 ```
 server {
         server_name localhost;
@@ -101,8 +103,6 @@ $ chown -R www-data:www-data
 $ systemctl nginx reload
 ```
 
-
-
 ## Configuration
 
 There's a couple of things you can / need to configure to get Dashboard to look and behave just as you want it to.
@@ -125,7 +125,8 @@ To show the apps you want to show, change `apps.json` to resemble the following:
           "name": "[Name of the app]",
           "displayURL": "[URL you want to show]",
           "url": "[URL to redirect to]",
-          "icon": "[Icon code]"
+          "icon": "[Icon code]",
+          "newTab": true
         },
         ...
       ]
@@ -137,14 +138,16 @@ To show the apps you want to show, change `apps.json` to resemble the following:
       "name": "[Name of the app]",
       "displayURL": "[URL you want to show]",
       "url": "[URL to redirect to]",
-      "icon": "[Icon code]"
+      "icon": "[Icon code]",
+      "newTab": false
     },
     ...
   ]
 }
 ```
 
 Wherein either `apps` or `categories` can be omitted as needed.
+`newTab` is optional and defaults to `false`.
 
 To find icons, simply go to the [Material Design Icon Library](https://material.io/icons/) and copy one of the codes for an icon there.
 
@@ -160,7 +163,8 @@ To show bookmarks, `bookmarks.json` needs to resemble the following:
       "items": [
         {
           "name": "[Bookmark Name]",
-          "url": "[Bookmark URL]"
+          "url": "[Bookmark URL]",
+          "newTab": true
         },
         ...
       ]
@@ -170,6 +174,8 @@ To show bookmarks, `bookmarks.json` needs to resemble the following:
 }
 ```
 
+`newTab` is optional and defaults to `false`.
+
 ### Themes
 
 In order to customize theming, `themes.json` needs to resemble this:
@@ -206,6 +212,13 @@ For search providers to work, make sure your `search.json` resembles the followi
 }
 ```
 
+You can also customize whether or not the search bar automatically focusses on render by adding
+the following to `search.json`, on the same level where properties like `providers` are located:
+
+```json
+  "autoFocus": true,
+```
+
 ### Imprint
 
 In order for the imprint-modal to show up, make sure your `imprint.json` resembles the following:
@@ -244,10 +257,7 @@ In order for the imprint-modal to show up, make sure your `imprint.json` resembl
 [codecov]: https://codecov.io/gh/phntxx/dashboard
 [repo]: https://github.com/phntxx/dashboard
 [license]: https://github.com/phntxx/dashboard/LICENSE
-[circleci]: https://circleci.com/gh/phntxx/dashboard
 [shield-docker]: https://img.shields.io/docker/cloud/build/phntxx/dashboard
 [shield-docker-image]: https://img.shields.io/docker/image-size/phntxx/dashboard/latest
-[shield-circleci]: https://circleci.com/gh/phntxx/dashboard.svg?style=shield
 [shield-codecov]: https://codecov.io/gh/phntxx/dashboard/branch/master/graph/badge.svg
 [shield-license]: https://img.shields.io/github/license/phntxx/dashboard.svg
-[shield-deps]: https://img.shields.io/david/phntxx/dashboard