various updates

- use npm packages - commonize webui appearance with LizardByte website - change docs theme to `furo` - add cpu name to cpu dashboard chart - update python dependenices
LizardByte · Nov 5, 2022 · baba2d5 · baba2d5
1 parent 44ec669
commit baba2d5
Show file tree

Hide file tree

Showing 1,923 changed files with 447 additions and 114,159 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -40,13 +40,13 @@ jobs:
         if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
         uses: actions/checkout@v3
 
-      - name: Install Python 3.9
+      - name: Install Python
         if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-        uses: actions/setup-python@v3  # https://github.com/actions/setup-python
+        uses: actions/setup-python@v3
         with:
           python-version: '3.9'
 
-      - name: Set up Python 3.9 Dependencies
+      - name: Set up Python Dependencies
         if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
         run: |
           echo "Installing RetroArcher Requirements"
@@ -83,24 +83,28 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install Python 3.9
-        uses: actions/setup-python@v3  # https://github.com/actions/setup-python
+        uses: actions/setup-python@v3
         with:
           python-version: '3.9'
           architecture: ${{ matrix.architecture }}
 
-      - name: Set up Python 3.9 Dependencies
+      - name: Set up Python Dependencies
         run: |
-          echo "Installing RetroArcher Requirements"
           python -m pip install --upgrade pip setuptools
           python -m pip install -r requirements-dev.txt --no-warn-script-location
 
       - name: Compile Locale Translations
         run: |
           python ./scripts/_locale.py --compile
 
+      - name: Install npm packages
+        working-directory: web
+        run: |
+          npm install
+
       - name: Compile Docs
+        working-directory: docs
         run: |
-          cd docs
           make html
 
       - name: Build pyinstaller package

diff --git a/.github/workflows/ci-docker.yml b/.github/workflows/ci-docker.yml
@@ -57,7 +57,7 @@ jobs:
       - name: Log
         if: failure()
         run: |
-          Hadolint outcome: ${{ steps.hadolint.outcome }} >> $GITHUB_STEP_SUMMARY
+          echo "Hadolint outcome: ${{ steps.hadolint.outcome }}" >> $GITHUB_STEP_SUMMARY
           cat "./hadolint.log" >> $GITHUB_STEP_SUMMARY
 
   check_changelog:

diff --git a/.gitignore b/.gitignore
@@ -151,6 +151,10 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
+# npm
+node_modules/
+*package-lock.json
+
 # RetroArcher directories
 logs/
 

diff --git a/Dockerfile b/Dockerfile
@@ -1,35 +1,47 @@
-FROM python:3.9.6-slim-bullseye
+FROM python:3.9.6-slim-bullseye as retroarcher-base
 
-LABEL maintainer="LizardByte"
+FROM retroarcher-base as retroarcher-build
 
-ENV RETROARCHER_DOCKER=True
-ENV TZ=UTC
+# install build dependencies
+RUN apt-get update -y \
+     && apt-get install -y --no-install-recommends \
+        build-essential \
+        nodejs \
+        npm \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
 
 # setup app directory
-WORKDIR /app
+WORKDIR /build
 COPY . .
 
 # setup python requirements
-RUN \
-  python -m pip install --no-cache-dir --upgrade pip && \
-  python -m pip install --no-cache-dir -r requirements.txt
+RUN python -m pip install --no-cache-dir --upgrade pip && \
+    python -m pip install --no-cache-dir -r requirements.txt
 
 # compile locales
 RUN python scripts/_locale.py --compile
 
+# setup npm and dependencies
+WORKDIR /build/web
+RUN npm install
+
 # compile docs
-WORKDIR /app/docs
+WORKDIR /build/docs
 RUN sphinx-build -M html source build
 
+FROM retroarcher-base as retroarcher
+
+# copy app from builder
+COPY --from=retroarcher-build /build/ /app/
+
 # setup user
-RUN \
-  groupadd -g 1000 retroarcher && \
-  useradd -u 1000 -g 1000 retroarcher
+RUN groupadd -g 1000 retroarcher && \
+    useradd -u 1000 -g 1000 retroarcher
 
 # create config directory
-RUN \
-  mkdir /config && \
-  touch /config/DOCKER
+RUN mkdir /config && \
+    touch /config/DOCKER
 VOLUME /config
 
 CMD ["python", "retroarcher.py"]

diff --git a/README.rst b/README.rst
@@ -1,5 +1,3 @@
-:github_url: https://github.com/RetroArcher/RetroArcher/tree/nightly/README.rst
-
 Overview
 ========
 
@@ -26,73 +24,28 @@ Integrations
    :alt: CrowdIn
    :target: https://crowdin.com/project/retroarcher
 
-.. image:: https://img.shields.io/static/v1?style=for-the-badge&label=Feature+Upvote&message=Request&color=important&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAIKSURBVDhPnZM9aFNRFIDPeWkFlw5uEW3TqojiYqIO71GHSPOGdlNxEgRBEXGTIhkK/g6hKHQQzFYquOggRfFlKAjmKcLLoqIOXRQMqDh0kSrN9Tt58RkERXvg45577/m9Pyq/SSkIdzjnTqEeglHowDI0RLTeiqN36JlkAXAcwPES6nkYgJfwBsxmD+yEVbjIUo1AFjgNgHMO5zuoR+Ghqk4nzeiV7f0UbErYXEc9CLdU9EwSRy5nm/mt26oM5+AGMU8Q/WPRDz3WZ8HfvGXscRI3PuSHt9/GZgROQrv9fjlRIueJbD0+JfMEmTvmLOLqPUOTGhkvWMaiXxlk/gwK2I96OB9nspHM1a5zUDHnm6yZs+sx7cRdYZRW3PjOMAOb8D2CsZSBk3XP9wehYj7H/DTMw2uI4T5UqYwDRFS5EVmBsgUowFsiuzWRcfSzQK9qFdhJf6PUY4wPSDJDy7tbzciqsLbHLEAm6iTGeErVs4MkXiq0tkrWw+xNdtyaVZWJciiPGHdBwarorvaEvRcMn1i3NjMp+eEgZ/IZddEqWIJhYh2wzX8RslQYhmDJ43oWUL6yfG1fYNf3dykG4QZsL6N+oaW7HnfbZnIVyh0ns5Td/z/uwWKqps9dXPd97AW79pX0KfuVHGX931P2eMpPIreuz6QqtaTZ+PWZ+oVAf/zOVFansr7vLPIDh9/cyYgVQMYAAAAASUVORK5CYII=
-   :alt: Feature Upvote
-   :target: https://retroarcher.github.io/featurereq/
-
-Donate
-------
-
-.. image:: https://img.shields.io/github/sponsors/reenignearcher?label=Github%20Sponsors&style=for-the-badge&color=green&logo=githubsponsors
-   :alt: GitHub Sponsors
-   :target: https://github.com/sponsors/ReenigneArcher
-
-.. image:: https://img.shields.io/static/v1?style=for-the-badge&label=MEE6&message=Donate&color=green&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAklEQVR4AewaftIAAAG6SURBVJXBPWgTARiA4fe7H/WKCGoo0qAcIhUJHCSnoIgZYiq4ugk6BEuEimRxk04SwcEhU0pMDY5xcnSK0N22XCexYHSxkpBCB69gc58ntHCcEerzCCmVIMyjVEFLCi4xgT5ID6HV8Zw1EoR9D4LQMQwav8Y6DwiTqW1KO4qoLXtOSMwkNr8ROmON3kfKHUD4N4kUX9Eblx8tdleb9T2D2Fi1AVLk0KQ4Vm0Qk0oQ5lX1IyD8HxUR31DVKiDsU43YHQ1I290eolFEgqhq1RAokbDx+iXd8nl2vm1y4OfgO2/nLrC+9JwkgZKl4JIwc/Um4WCLqeksB46dzJC7/5izxdskKbgWKZlcgUyuQJJh2fi1Z0xiCfQVZkkJhz/Y+fqZP+zjJzh10SNNoG8p9IBZUkafAjaf3OW0bTO6doviizekKfQsEWmp6kNASMhen6O89I6Z7QEfrpSJ+IuKSMtcb9a38gtPs4BPyvDMOb64l9AjR0kTod3xpl4ZxEyRGugKh6YrpkiNmElstVnf8xcWu5Yp05FSAITJ1DalLci9Zc8JiQkplSDMo1RBSwouMYE+SA+h1fGcNRJ+A8xgoQAar6IXAAAAAElFTkSuQmCC
-   :alt: MEE6
-   :target: https://mee6.xyz/m/804382334370578482
-
-.. image:: https://img.shields.io/static/v1?style=for-the-badge&label=Patreon&message=Donate&color=green&logo=patreon
-   :alt: Patreon
-   :target: https://www.patreon.com/RetroArcher
-
-.. image:: https://img.shields.io/static/v1?style=for-the-badge&label=PayPal&message=Donate&color=green&logo=paypal
-   :alt: PayPal
-   :target: https://www.paypal.com/paypalme/ReenigneArcher
-
-Social
-------
-
-.. image:: https://img.shields.io/static/v1?style=for-the-badge&label=Facebook+Page&message=Like&color=blue&logo=facebook
-   :alt: Facebook Page
-   :target: https://www.facebook.com/RetroArcherFB
-
-.. image:: https://img.shields.io/static/v1?style=for-the-badge&label=Facebook+Group&message=Join&color=blue&logo=facebook
-   :alt: Facebook Group
-   :target: https://www.facebook.com/groups/retroracher
-
-.. image:: https://img.shields.io/reddit/subreddit-subscribers/retroarcher?label=Reddit&style=for-the-badge&logo=reddit
-   :alt: Reddit
-   :target: https://www.reddit.com/r/RetroArcher
-
-.. image:: https://img.shields.io/twitter/follow/RetroArcherTW?label=Twitter&style=for-the-badge&color=blue&logo=twitter
-   :alt: Twitter
-   :target: https://twitter.com/RetroArcherTW
-
-.. image:: https://img.shields.io/youtube/channel/subscribers/UCtSzs1U8B7yYX1uE58a6BxA?label=YouTube&style=for-the-badge&logo=youtube
-   :alt: YouTube
-   :target: https://www.youtube.com/c/RetroArcher
-
 Support
 ---------
 
-.. image:: https://img.shields.io/discord/804382334370578482?label=Discord&style=for-the-badge&color=blue&logo=discord
-   :alt: Discord
-   :target: https://retroarcher.github.io/discord
-
-.. image:: https://img.shields.io/github/discussions/retroarcher/retroarcher?logo=github&style=for-the-badge
-   :alt: GitHub Discussions
-   :target: https://github.com/RetroArcher/RetroArcher/discussions
+Our support methods are listed in our
+`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`_.
 
 Downloads
 ---------
 
-.. image:: https://img.shields.io/github/downloads/retroarcher/retroarcher/total?style=for-the-badge&logo=github
+.. image:: https://img.shields.io/github/downloads/lizardbyte/retroarcher/total?style=for-the-badge&logo=github
    :alt: GitHub Releases
-   :target: https://github.com/RetroArcher/RetroArcher/releases/latest
+   :target: https://github.com/LizardByte/RetroArcher/releases/latest
 
-.. image:: https://img.shields.io/docker/pulls/retroarcher/retroarcher?style=for-the-badge&logo=docker
+.. image:: https://img.shields.io/docker/pulls/lizardbyte/retroarcher?style=for-the-badge&logo=docker
    :alt: Docker
-   :target: https://hub.docker.com/r/retroarcher/retroarcher
+   :target: https://hub.docker.com/r/lizardbyte/retroarcher
+
+Stats
+------
+.. image:: https://img.shields.io/github/stars/lizardbyte/retroarcher?logo=github&style=for-the-badge
+   :alt: GitHub stars
+   :target: https://github.com/LizardByte/RetroArcher
 
 Project Goals
 -------------
@@ -119,7 +72,7 @@ Replace Existing RetroArcher.bundle
    - No longer get metadata from IGDB
    - Make an API request to this self-hosted server to get metadata
 
-.. _Sunshine: https://sunshinestream.github.io/
+.. _Sunshine: https://app.lizardbyte.dev/
 .. _GeForce Experience: https://www.nvidia.com/en-us/support/gamestream/
 .. _Cemu: https://cemu.info/
 .. _RetroArch: https://www.retroarch.com/

diff --git a/docs/source/about/build.rst b/docs/source/about/build.rst
@@ -1,5 +1,3 @@
-:github_url: https://github.com/LizardByte/RetroArcher/tree/nightly/docs/source/about/build.rst
-
 Build
 =====
 RetroArcher binaries are built using `pyinstaller <https://pypi.org/project/pyinstaller/>`_. Cross compilation is not
@@ -10,7 +8,6 @@ Use Python 3.7+
 Clone
 -----
 Ensure `git <https://git-scm.com/>`_ is installed and run the following:
-
    .. code-block:: bash
 
       git clone https://github.com/lizardbyte/retroarcher.git
@@ -20,14 +17,14 @@ Setup venv
 ----------
 It is recommended to setup and activate a `venv`_ within the `retroarcher` directory.
 
-Install Requirements
---------------------
-Standard Requirements
+Install Python Requirements
+---------------------------
+**Standard Requirements**
    .. code-block:: bash
 
       python -m pip install -r requirements.txt
 
-Advanced Requirements
+**Advanced Requirements**
    Required for:
       - :ref:`Test with flake8 <contributing/testing:flake8>`
       - :ref:`Test with pytest <contributing/testing:pytest>`
@@ -41,24 +38,33 @@ Advanced Requirements
 
 Compile Locales
 ---------------
-   .. code-block:: bash
+.. code-block:: bash
+
+   python ./scripts/_locale.py --compile
 
-      python ./scripts/_locale.py --compile
+Install NPM Requirements
+------------------------
+.. code-block:: bash
+
+      cd web
+      npm install
+      cd ..
 
 Compile Docs
 ------------
 Docs are visible by the webapp and therefore must be compiled.
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      cd docs
-      make html
+   cd docs
+   make html
+   cd ..
 
 Compile Binary
 --------------
-   .. code-block:: bash
+.. code-block:: bash
 
-      python ./scripts/build.py
+   python ./scripts/build.py
 
 Remote Build
 ------------

diff --git a/docs/source/about/docker.rst b/docs/source/about/docker.rst
@@ -1,5 +1,3 @@
-:github_url: https://github.com/LizardByte/RetroArcher/tree/nightly/DOCKER_README.md
-
 Docker
 ------
 

diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst
@@ -1,5 +1,3 @@
-:github_url: https://github.com/LizardByte/RetroArcher/tree/nightly/docs/source/about/installation.rst
-
 Installation
 ============
 The recommended method for running RetroArcher is to use the `binaries`_ bundled with the `latest release`_.

diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst
@@ -1,5 +1,3 @@
-:github_url: https://github.com/LizardByte/RetroArcher/tree/nightly/docs/source/about/usage.rst
-
 Usage
 =====
 
@@ -11,12 +9,12 @@ Arguments
 ---------
 To get a list of available arguments run the following:
 
-   Binary
-      .. code-block:: bash
+**Binary**
+   .. code-block:: bash
 
-         retroarcher --help
+      retroarcher --help
 
-   Python
-      .. code-block:: bash
+**Python**
+   .. code-block:: bash
 
-         python retroarcher.py --help
+      python retroarcher.py --help
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -73,23 +73,11 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 html_theme_options = {
-    # 'analytics_id': 'G-XXXXXXXXXX',  #  Provided by Google in your dashboard
-    # 'analytics_anonymize_ip': False,
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': True,
-    'vcs_pageview_mode': 'blob',
-    # 'style_nav_header_background': 'white',
-    # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False,
+    "top_of_page_button": "edit",
+    "source_edit_link": "https://github.com/lizardbyte/retroarcher/tree/nightly/docs/source/{filename}",
 }
 
 # extension config options
-Original file line number
+Diff line change
@@ -1,5 +1,3 @@
-    :github_url: https://github.com/LizardByte/RetroArcher/tree/nightly/DOCKER_README.md
     Docker
     ------
@@ Expand Down @@