![\"All](\"https://img.shields.io/badge/all_contributors-<%=){kind=icon}
-orange.svg\"/>-orange.svg\"/>",
diff --git a/.dockerignore b/.dockerignore
index 4095dce56..3ddaa574e 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -8,16 +8,20 @@
.git
.gitbook.yaml
.gitconfig
-.gitignore
.github
+.gitignore
.next
.prettierignore
-config/db/db.sqlite3
-config/db/logs/overseerr.log
+config/db/*
+config/logs/*
+config/*.json
+dist
Dockerfile*
docker-compose.yml
docs
LICENSE
node_modules
+public/os_logo_filled.png
+public/preview.jpg
snap
stylelint.config.js
diff --git a/.eslintrc.js b/.eslintrc.js
index c7286440c..b1c6f4b9f 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -4,12 +4,10 @@ module.exports = {
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
- 'prettier/@typescript-eslint', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
- 'plugin:prettier/recommended', // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
'plugin:jsx-a11y/recommended',
'plugin:react/recommended',
'plugin:react-hooks/recommended',
- 'prettier/react',
+ 'prettier',
],
parserOptions: {
ecmaVersion: 6,
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 000000000..2883a5d26
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,26 @@
+* text eol=lf
+
+#
+## These files are binary and should be left untouched
+#
+
+# (binary is a macro for -text -diff)
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.mov binary
+*.mp4 binary
+*.mp3 binary
+*.flv binary
+*.fla binary
+*.swf binary
+*.gz binary
+*.zip binary
+*.7z binary
+*.ttf binary
+*.eot binary
+*.woff binary
+*.pyc binary
+*.pdf binary
diff --git a/.gitbook.yaml b/.gitbook.yaml
index 6c5133ed3..2b0a6c4e8 100644
--- a/.gitbook.yaml
+++ b/.gitbook.yaml
@@ -1,5 +1,5 @@
root: ./docs
structure:
- readme: README.md
- summary: SUMMARY.md
+ readme: README.md
+ summary: SUMMARY.md
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index 9d966899f..6b2dc7002 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1,2 +1,2 @@
-github: [sct]
+github: [sct]
patreon: overseerr
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 522628a6d..f65cfa766 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: Support via Discord
- url: https://discord.gg/PkCWJSeCk7
+ url: https://discord.gg/overseerr
about: Chat with users and devs on support and setup related topics.
- name: Support via GitHub Discussions
url: https://github.com/sct/overseerr/discussions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index ffc747549..9945e234d 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -12,53 +12,55 @@ jobs:
test:
name: Lint & Test Build
runs-on: ubuntu-20.04
- container: node:12.18-alpine
+ container: node:14.17-alpine
steps:
- - name: checkout
- uses: actions/checkout@v2
- - name: install dependencies
+ - name: Checkout
+ uses: actions/checkout@v2.3.4
+ - name: Install dependencies
env:
HUSKY_SKIP_INSTALL: 1
run: yarn
- - name: lint
+ - name: Lint
run: yarn lint
- - name: build
+ - name: Build
run: yarn build
+
build_and_push:
- name: Build & Publish to Docker Hub
+ name: Build & Publish Docker Images
needs: test
if: github.ref == 'refs/heads/develop' && !contains(github.event.head_commit.message, '[skip ci]')
runs-on: ubuntu-20.04
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v2.3.4
- name: Set up QEMU
- uses: docker/setup-qemu-action@v1
+ uses: docker/setup-qemu-action@v1.2.0
- name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v1
+ uses: docker/setup-buildx-action@v1.3.0
- name: Cache Docker layers
- uses: actions/cache@v2.1.4
+ uses: actions/cache@v2.1.6
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-
- - name: Login to DockerHub
- uses: docker/login-action@v1
+ - name: Log in to Docker Hub
+ uses: docker/login-action@v1.9.0
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}
- - name: Login to GitHub Container Registry
- uses: docker/login-action@v1
+ - name: Log in to GitHub Container Registry
+ uses: docker/login-action@v1.9.0
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
- password: ${{ secrets.CR_PAT }}
+ password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push
- uses: docker/build-push-action@v2
+ uses: docker/build-push-action@v2.5.0
with:
context: .
file: ./Dockerfile
+ platforms: linux/amd64,linux/arm64,linux/arm/v7
push: true
build-args: |
COMMIT_TAG=${{ github.sha }}
@@ -68,7 +70,15 @@ jobs:
ghcr.io/sct/overseerr:develop
ghcr.io/sct/overseerr:${{ github.sha }}
cache-from: type=local,src=/tmp/.buildx-cache
- cache-to: type=local,dest=/tmp/.buildx-cache,mode=max
+ cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
+ - # Temporary fix
+ # https://github.com/docker/build-push-action/issues/252
+ # https://github.com/moby/buildkit/issues/1896
+ name: Move cache
+ run: |
+ rm -rf /tmp/.buildx-cache
+ mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+
discord:
name: Send Discord Notification
needs: build_and_push
@@ -76,8 +86,7 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Get Build Job Status
- uses: technote-space/workflow-conclusion-action@v2.1.2
-
+ uses: technote-space/workflow-conclusion-action@v2.1.6
- name: Combine Job Status
id: status
run: |
@@ -87,7 +96,6 @@ jobs:
else
echo ::set-output name=status::$WORKFLOW_CONCLUSION
fi
-
- name: Post Status to Discord
uses: sarisia/actions-status-discord@v1
with:
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 13e3e01d2..809d47068 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -11,12 +11,12 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Generate Swagger UI
- uses: Legion2/swagger-ui-action@v1
+ uses: Legion2/swagger-ui-action@v1.1.2
with:
output: swagger-ui
spec-file: overseerr-api.yml
- name: Deploy to GitHub Pages
- uses: peaceiris/actions-gh-pages@v3
+ uses: peaceiris/actions-gh-pages@v3.8.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: swagger-ui
diff --git a/.github/workflows/invalid_template.yml b/.github/workflows/invalid_template.yml
index 641b1d6a5..24f95d741 100644
--- a/.github/workflows/invalid_template.yml
+++ b/.github/workflows/invalid_template.yml
@@ -8,7 +8,7 @@ jobs:
support:
runs-on: ubuntu-20.04
steps:
- - uses: dessant/support-requests@v2
+ - uses: dessant/support-requests@v2.0.1
with:
github-token: ${{ github.token }}
support-label: 'invalid:template-incomplete'
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
new file mode 100644
index 000000000..a42464280
--- /dev/null
+++ b/.github/workflows/preview.yml
@@ -0,0 +1,44 @@
+name: Overseerr Preview
+
+on:
+ push:
+ tags:
+ - 'preview-*'
+
+jobs:
+ build_and_push:
+ name: Build & Publish Docker Preview Images
+ runs-on: ubuntu-20.04
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2.3.4
+ - name: Get the version
+ id: get_version
+ run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v1.2.0
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v1.3.0
+ - name: Log in to Docker Hub
+ uses: docker/login-action@v1.9.0
+ with:
+ username: ${{ secrets.DOCKER_USERNAME }}
+ password: ${{ secrets.DOCKER_TOKEN }}
+ - name: Log in to GitHub Container Registry
+ uses: docker/login-action@v1.9.0
+ with:
+ registry: ghcr.io
+ username: ${{ github.repository_owner }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+ - name: Build and push
+ uses: docker/build-push-action@v2.5.0
+ with:
+ context: .
+ file: ./Dockerfile
+ platforms: linux/amd64
+ push: true
+ build-args: |
+ COMMIT_TAG=${{ github.sha }}
+ tags: |
+ sctx/overseerr:${{ steps.get_version.outputs.VERSION }}
+ ghcr.io/sct/overseerr:${{ steps.get_version.outputs.VERSION }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 9e929ce9f..0f1f661d7 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -9,31 +9,47 @@ jobs:
test:
name: Lint & Test Build
runs-on: ubuntu-20.04
- container: node:12.18-alpine
+ container: node:14.17-alpine
steps:
- - name: checkout
- uses: actions/checkout@v2
- - name: install dependencies
+ - name: Checkout
+ uses: actions/checkout@v2.3.4
+ - name: Install dependencies
env:
HUSKY_SKIP_INSTALL: 1
run: yarn
- - name: lint
+ - name: Lint
run: yarn lint
- - name: build
+ - name: Build
run: yarn build
+
semantic-release:
name: Tag and release latest version
needs: test
runs-on: ubuntu-20.04
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v2.3.4
with:
fetch-depth: 0
- - name: Setup Node.js
- uses: actions/setup-node@v1
+ - name: Set up Node.js
+ uses: actions/setup-node@v2
with:
- node-version: 12
+ node-version: 14
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v1.2.0
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v1.3.0
+ - name: Log in to Docker Hub
+ uses: docker/login-action@v1.9.0
+ with:
+ username: ${{ secrets.DOCKER_USERNAME }}
+ password: ${{ secrets.DOCKER_TOKEN }}
+ - name: Log in to GitHub Container Registry
+ uses: docker/login-action@v1.9.0
+ with:
+ registry: ghcr.io
+ username: ${{ github.repository_owner }}
+ password: ${{ secrets.GITHUB_TOKEN }}
- name: Install dependencies
run: yarn
- name: Release
@@ -42,6 +58,7 @@ jobs:
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
run: npx semantic-release
+
build-snap:
name: Build Snap Package (${{ matrix.architecture }})
needs: semantic-release
@@ -55,14 +72,13 @@ jobs:
- armhf
steps:
- name: Checkout Code
- uses: actions/checkout@v2
+ uses: actions/checkout@v2.3.4
with:
fetch-depth: 0
- name: Switch to master branch
run: git checkout master
- name: Pull latest changes
run: git pull
-
- name: Prepare
id: prepare
run: |
@@ -72,35 +88,31 @@ jobs:
else
echo ::set-output name=RELEASE::edge
fi
-
- name: Set Up QEMU
- uses: docker/setup-qemu-action@v1
+ uses: docker/setup-qemu-action@v1.2.0
with:
image: tonistiigi/binfmt@sha256:df15403e06a03c2f461c1f7938b171fda34a5849eb63a70e2a2109ed5a778bde
-
- name: Build Snap Package
uses: diddlesnaps/snapcraft-multiarch-action@v1
id: build
with:
architecture: ${{ matrix.architecture }}
-
- name: Upload Snap Package
uses: actions/upload-artifact@v2
with:
name: overseerr-snap-package-${{ matrix.architecture }}
path: ${{ steps.build.outputs.snap }}
-
- name: Review Snap Package
- uses: diddlesnaps/snapcraft-review-tools-action@v1.2.0
+ uses: diddlesnaps/snapcraft-review-tools-action@v1.3.0
with:
snap: ${{ steps.build.outputs.snap }}
-
- name: Publish Snap Package
uses: snapcore/action-publish@v1
with:
store_login: ${{ secrets.SNAP_LOGIN }}
snap: ${{ steps.build.outputs.snap }}
release: ${{ steps.prepare.outputs.RELEASE }}
+
discord:
name: Send Discord Notification
needs: semantic-release
@@ -108,8 +120,7 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Get Build Job Status
- uses: technote-space/workflow-conclusion-action@v2.1.2
-
+ uses: technote-space/workflow-conclusion-action@v2.1.6
- name: Combine Job Status
id: status
run: |
@@ -119,7 +130,6 @@ jobs:
else
echo ::set-output name=status::$WORKFLOW_CONCLUSION
fi
-
- name: Post Status to Discord
uses: sarisia/actions-status-discord@v1
with:
diff --git a/.github/workflows/snap.yaml b/.github/workflows/snap.yaml
index ac68a3278..3e82fe9ae 100644
--- a/.github/workflows/snap.yaml
+++ b/.github/workflows/snap.yaml
@@ -2,7 +2,8 @@ name: Publish Snap
on:
push:
- branches: [develop]
+ branches:
+ - develop
jobs:
jobs:
@@ -11,25 +12,27 @@ jobs:
if: "!contains(github.event.head_commit.message, '[skip ci]')"
steps:
- name: Cancel Previous Runs
- uses: styfle/cancel-workflow-action@0.8.0
+ uses: styfle/cancel-workflow-action@0.9.0
with:
access_token: ${{ secrets.GITHUB_TOKEN }}
+
test:
name: Lint & Test Build
needs: jobs
runs-on: ubuntu-20.04
- container: node:12.18-alpine
+ container: node:14.17-alpine
steps:
- - name: checkout
- uses: actions/checkout@v2
- - name: install dependencies
+ - name: Checkout
+ uses: actions/checkout@v2.3.4
+ - name: Install dependencies
env:
HUSKY_SKIP_INSTALL: 1
run: yarn
- - name: lint
+ - name: Lint
run: yarn lint
- - name: build
+ - name: Build
run: yarn build
+
build-snap:
name: Build Snap Package (${{ matrix.architecture }})
needs: test
@@ -43,8 +46,7 @@ jobs:
- armhf
steps:
- name: Checkout Code
- uses: actions/checkout@v2
-
+ uses: actions/checkout@v2.3.4
- name: Prepare
id: prepare
run: |
@@ -54,35 +56,31 @@ jobs:
else
echo ::set-output name=RELEASE::edge
fi
-
- name: Set Up QEMU
- uses: docker/setup-qemu-action@v1
+ uses: docker/setup-qemu-action@v1.2.0
with:
image: tonistiigi/binfmt@sha256:df15403e06a03c2f461c1f7938b171fda34a5849eb63a70e2a2109ed5a778bde
-
- name: Build Snap Package
uses: diddlesnaps/snapcraft-multiarch-action@v1
id: build
with:
architecture: ${{ matrix.architecture }}
-
- name: Upload Snap Package
uses: actions/upload-artifact@v2
with:
name: overseerr-snap-package-${{ matrix.architecture }}
path: ${{ steps.build.outputs.snap }}
-
- name: Review Snap Package
- uses: diddlesnaps/snapcraft-review-tools-action@v1.2.0
+ uses: diddlesnaps/snapcraft-review-tools-action@v1.3.0
with:
snap: ${{ steps.build.outputs.snap }}
-
- name: Publish Snap Package
uses: snapcore/action-publish@v1
with:
store_login: ${{ secrets.SNAP_LOGIN }}
snap: ${{ steps.build.outputs.snap }}
release: ${{ steps.prepare.outputs.RELEASE }}
+
discord:
name: Send Discord Notification
needs: build-snap
@@ -90,8 +88,7 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Get Build Job Status
- uses: technote-space/workflow-conclusion-action@v2.1.2
-
+ uses: technote-space/workflow-conclusion-action@v2.1.6
- name: Combine Job Status
id: status
run: |
@@ -101,7 +98,6 @@ jobs:
else
echo ::set-output name=status::$WORKFLOW_CONCLUSION
fi
-
- name: Post Status to Discord
uses: sarisia/actions-status-discord@v1
with:
diff --git a/.github/workflows/support.yml b/.github/workflows/support.yml
index 4e9311ec1..09d86bc6b 100644
--- a/.github/workflows/support.yml
+++ b/.github/workflows/support.yml
@@ -8,7 +8,7 @@ jobs:
support:
runs-on: ubuntu-20.04
steps:
- - uses: dessant/support-requests@v2
+ - uses: dessant/support-requests@v2.0.1
with:
github-token: ${{ github.token }}
support-label: 'support'
@@ -18,8 +18,9 @@ jobs:
to be a support request. Please use our support channels
to get help with Overseerr.
- - [Discord](https://discord.gg/PkCWJSeCk7)
+ - [Discord](https://discord.gg/overseerr)
+
- [GitHub Discussions](https://github.com/sct/overseerr/discussions)
close-issue: true
- lock-issue: false
+ lock-issue: true
issue-lock-reason: 'off-topic'
diff --git a/.gitignore b/.gitignore
index 8e1866224..0bc4be4a5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -32,7 +32,7 @@ yarn-error.log*
.vercel
# database
-config/db/*.sqlite3
+config/db/*.sqlite3*
config/settings.json
# logs
diff --git a/.vscode/settings.json b/.vscode/settings.json
index c7f618e50..799ff92ae 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -15,8 +15,9 @@
"database": "./config/db/db.sqlite3"
}
],
- "i18n-ally.localesPaths": [
- "src/i18n",
- "src/i18n/locale"
- ]
+ "i18n-ally.localesPaths": ["src/i18n", "src/i18n/locale"],
+ "editor.codeActionsOnSave": {
+ "source.organizeImports": true
+ },
+ "editor.formatOnSave": true
}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9a97a7966..9e16f9eab 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,80 +1,87 @@
# Contributing to Overseerr
-All help is welcome and greatly appreciated. If you would like to contribute to the project, the instructions below can get you started...
+All help is welcome and greatly appreciated! If you would like to contribute to the project, the following instructions should get you started...
## Development
### Tools Required
-- HTML/Typescript/Javascript editor of choice. ([VSCode](https://code.visualstudio.com/) is recommended. Upon opening the project, a few extensions will be automatically recommended for install.)
-- [NodeJS](https://nodejs.org/en/download/) (Node 12.x.x or higher)
+- HTML/Typescript/Javascript editor
+ - [VSCode](https://code.visualstudio.com/) is recommended. Upon opening the project, a few extensions will be automatically recommended for install.
+- [NodeJS](https://nodejs.org/en/download/) (Node 14.x or higher)
- [Yarn](https://yarnpkg.com/)
- [Git](https://git-scm.com/downloads)
### Getting Started
-1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository to your own GitHub account and [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device:
```bash
git clone https://github.com/YOUR_USERNAME/overseerr.git
cd overseerr/
```
-2. Add the remote upstream.
+2. Add the remote `upstream`:
```bash
git remote add upstream https://github.com/sct/overseerr.git
```
-3. Create a new branch
+3. Create a new branch:
```bash
git checkout -b BRANCH_NAME develop
```
- - It is recommended to name the branch something relevant to the feature or fix you are working on.
- - An example of this would be `fix-title-cards` or `feature-new-system`.
- - Bad examples would be `patch` or `bug`.
+ - It is recommended to give your branch a meaningful name, relevant to the feature or fix you are working on.
+ - Good examples:
+ - `docs-docker`
+ - `feature-new-system`
+ - `fix-title-cards`
+ - Bad examples:
+ - `bug`
+ - `docs`
+ - `feature`
+ - `fix`
+ - `patch`
-4. Run development environment
+4. Run the development environment:
```bash
yarn
yarn dev
```
- - Alternatively you can run using [Docker](https://www.docker.com/) with `docker-compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly.
+ - Alternatively, you can use [Docker](https://www.docker.com/) with `docker-compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly.
-5. Create your patch and run appropriate tests.
+5. Create your patch and test your changes.
-6. Follow the [guidelines](#contributing-code).
-
-7. Should you need to update your fork, you can do so by rebasing from `upstream`:
-
- ```bash
- git fetch upstream
- git rebase upstream/develop
- git push origin BRANCH_NAME -f
- ```
+ - Be sure to follow both the [code](#contributing-code) and [UI text](#ui-text-style) guidelines.
+ - Should you need to update your fork, you can do so by rebasing from `upstream`:
+ ```bash
+ git fetch upstream
+ git rebase upstream/develop
+ git push origin BRANCH_NAME -f
+ ```
### Contributing Code
-- If you are taking on an existing bug or feature ticket, please comment on the [GitHub Issue](https://github.com/sct/overseerr/issues) to avoid multiple people working on the same thing.
+- If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/sct/overseerr/issues) to avoid multiple people working on the same thing.
- All commits **must** follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- - It is okay if you squash your PR down to be a single commit that fits this standard.
- - PRs with commits not following this standard will not be merged.
+ - It is okay to squash your pull request down into a single commit that fits this standard.
+ - Pull requests with commits not following this standard will **not** be merged.
- Please make meaningful commits, or squash them.
-- Always rebase your commit to the latest `develop` branch. Do not merge `develop` into your branch.
-- It is your responsibility to keep your branch up to date. It will not be merged unless its rebased off the latest `develop` branch.
+- Always rebase your commit to the latest `develop` branch. Do **not** merge `develop` into your branch.
+- It is your responsibility to keep your branch up-to-date. Your work will **not** be merged unless it is rebased off the latest `develop` branch.
- You can create a "draft" pull request early to get feedback on your work.
-- Your code must be formatted correctly or the tests will fail.
- - We use Prettier to format our codebase. It should automatically run with a `git` hook, but it is recommended to have the Prettier extension installed in your editor and format on save.
-- If you have questions or need help, you can reach out in [GitHub Discussions](https://github.com/sct/overseerr/discussions) or in our [Discord](https://discord.gg/PkCWJSeCk7).
-- Only open pull requests to `develop`. Never `master`. Any PRs opened to `master` will be closed.
+- Your code **must** be formatted correctly, or the tests will fail.
+ - We use Prettier to format our code base. It should automatically run with a Git hook, but it is recommended to have the Prettier extension installed in your editor and format on save.
+- If you have questions or need help, you can reach out via [Discussions](https://github.com/sct/overseerr/discussions) or our [Discord server](https://discord.gg/overseerr).
+- Only open pull requests to `develop`, never `master`! Any pull requests opened to `master` will be closed.
### UI Text Style
-When adding new UI text, please be sure to adhere to the following guidelines:
+When adding new UI text, please try to adhere to the following guidelines:
1. Be concise and clear, and use as few words as possible to make your point.
2. Use the Oxford comma where appropriate.
@@ -90,7 +97,7 @@ When adding new UI text, please be sure to adhere to the following guidelines:
## Translation
-We use [Weblate](https://hosted.weblate.org/engage/overseerr/) for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please [open a feature request on GitHub](https://github.com/sct/overseerr/issues/new/choose).
+We use [Weblate](https://hosted.weblate.org/engage/overseerr/) for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please [open a feature request](https://github.com/sct/overseerr/issues/new/choose).
diff --git a/Dockerfile b/Dockerfile
index 281ba10e4..cb80274ee 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,33 +1,46 @@
-FROM node:14.15-alpine AS BUILD_IMAGE
+FROM node:14.17-alpine AS BUILD_IMAGE
+
+WORKDIR /app
+
+ARG TARGETPLATFORM
+ENV TARGETPLATFORM=${TARGETPLATFORM:-linux/amd64}
+
+RUN \
+ case "${TARGETPLATFORM}" in \
+ 'linux/arm64') apk add --no-cache python make g++ ;; \
+ 'linux/arm/v7') apk add --no-cache python make g++ ;; \
+ esac
+
+COPY package.json yarn.lock ./
+RUN yarn install --frozen-lockfile --network-timeout 1000000
+
+COPY . ./
ARG COMMIT_TAG
ENV COMMIT_TAG=${COMMIT_TAG}
-COPY . /app
-WORKDIR /app
-
-RUN yarn --frozen-lockfile && \
- yarn build
+RUN yarn build
# remove development dependencies
RUN yarn install --production --ignore-scripts --prefer-offline
-RUN rm -rf src && \
- rm -rf server
+RUN rm -rf src server
RUN touch config/DOCKER
RUN echo "{\"commitTag\": \"${COMMIT_TAG}\"}" > committag.json
-FROM node:14.15-alpine
+FROM node:14.17-alpine
-RUN apk add --no-cache tzdata
-
-# copy from build image
-COPY --from=BUILD_IMAGE /app /app
WORKDIR /app
-CMD yarn start
+RUN apk add --no-cache tzdata tini
+
+# copy from build image
+COPY --from=BUILD_IMAGE /app ./
+
+ENTRYPOINT [ "/sbin/tini", "--" ]
+CMD [ "yarn", "start" ]
EXPOSE 5055
diff --git a/Dockerfile.local b/Dockerfile.local
index 474705136..b0b922e1f 100644
--- a/Dockerfile.local
+++ b/Dockerfile.local
@@ -1,4 +1,4 @@
-FROM node:12.18-alpine
+FROM node:14.17-alpine
COPY . /app
WORKDIR /app
diff --git a/README.md b/README.md
index 70bd55d5d..02c4a81a8 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,18 @@
-
+
-
+
@@ -68,7 +44,7 @@ For more information or alternative installation methods, please see the [Overse
## Support
- Check out the [Overseerr Documentation](https://docs.overseerr.dev/) before asking for help. Your question might already be in the [FAQ](https://docs.overseerr.dev/support/faq).
-- You can get support on [Discord](https://discord.gg/PkCWJSeCk7).
+- You can get support on [Discord](https://discord.gg/overseerr).
- You can ask questions in the Help category of our [GitHub Discussions](https://github.com/sct/overseerr/discussions).
- Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/sct/overseerr/issues).
@@ -82,7 +58,7 @@ You can also access the API documentation from your local Overseerr install at h
You can ask questions, share ideas, and more in [GitHub Discussions](https://github.com/sct/overseerr/discussions).
-If you would like to chat with other members of our growing community, [join the Overseerr Discord server](https://discord.gg/PkCWJSeCk7)!
+If you would like to chat with other members of our growing community, [join the Overseerr Discord server](https://discord.gg/overseerr)!
Our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) applies to all Overseerr community channels.
@@ -140,6 +116,39 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
{appDataPath} volume mount was not configured properly. All data will be cleared when the container is stopped or restarted.',
});
@@ -26,14 +25,14 @@ const AppDataWarning: React.FC = () => {
return (
<>
{!data.appData && (
-
{intl.formatMessage(
@@ -216,24 +277,29 @@ const CollectionDetails: React.FC
- {data.overview - ? data.overview - : intl.formatMessage(messages.overviewunavailable)} -
-{data.overview}
(
ref?: React.Ref
+
diff --git a/src/components/Common/CachedImage/index.tsx b/src/components/Common/CachedImage/index.tsx
new file mode 100644
index 000000000..c91f09465
--- /dev/null
+++ b/src/components/Common/CachedImage/index.tsx
@@ -0,0 +1,18 @@
+import Image, { ImageProps } from 'next/image';
+import React from 'react';
+import useSettings from '../../../hooks/useSettings';
+
+/**
+ * The CachedImage component should be used wherever
+ * we want to offer the option to locally cache images.
+ *
+ * It uses the `next/image` Image component but overrides
+ * the `unoptimized` prop based on the application setting `cacheImages`.
+ **/
+const CachedImage: React.FC
);
diff --git a/src/components/Common/List/index.tsx b/src/components/Common/List/index.tsx
index 689fba5cb..6d447fcb8 100644
--- a/src/components/Common/List/index.tsx
+++ b/src/components/Common/List/index.tsx
@@ -3,15 +3,16 @@ import { withProperties } from '../../../utils/typeHelpers';
interface ListItemProps {
title: string;
+ className?: string;
}
-const ListItem: React.FC
{backgroundImages.map((imageUrl, i) => (
+ >
+
))}
diff --git a/src/components/Common/ListView/index.tsx b/src/components/Common/ListView/index.tsx
index 5b3b0bc3b..78c08bf76 100644
--- a/src/components/Common/ListView/index.tsx
+++ b/src/components/Common/ListView/index.tsx
@@ -1,17 +1,14 @@
import React from 'react';
+import { useIntl } from 'react-intl';
import {
- TvResult,
MovieResult,
PersonResult,
+ TvResult,
} from '../../../../server/models/Search';
-import TitleCard from '../../TitleCard';
import useVerticalScroll from '../../../hooks/useVerticalScroll';
+import globalMessages from '../../../i18n/globalMessages';
import PersonCard from '../../PersonCard';
-import { defineMessages, useIntl } from 'react-intl';
-
-const messages = defineMessages({
- noresults: 'No results.',
-});
+import TitleCard from '../../TitleCard';
interface ListViewProps {
items?: (TvResult | MovieResult | PersonResult)[];
@@ -34,11 +31,11 @@ const ListView: React.FC
-
- {intl.formatMessage(messages.noresults)}
+ {intl.formatMessage(globalMessages.noresults)}
)}
-
- {items?.map((title) => {
+
+ {items?.map((title, index) => {
let titleCard: React.ReactNode;
switch (title.mediaType) {
@@ -90,7 +87,7 @@ const ListView: React.FC
{
if (e.key === 'Escape') {
typeof onCancel === 'function' && backgroundClickable
@@ -98,18 +101,35 @@ const Modal: React.FC
-
- {iconSvg && (
-
- {iconSvg}
-
- )}
+ {backdrop && (
+
+
+ )}
+
+ {iconSvg &&
{children && (
- {iconSvg}}
= ({
>
{title && (
{title}
@@ -126,12 +146,12 @@ const Modal: React.FC
+
{children}
)}
{(onCancel || onOk || onSecondary || onTertiary) && (
-
+
{typeof onOk === 'function' && (