From 2e213376e3316e84e79df22f3bdacf30f3c680c4 Mon Sep 17 00:00:00 2001 From: Sean Norwood Date: Tue, 18 Oct 2022 14:28:37 -0500 Subject: [PATCH] Initial --- .devcontainer/Dockerfile | 28 - .devcontainer/devcontainer.json | 64 - .dockerignore | 32 +- .env.example | 3 + .env.local.example | 8 - .eslintrc.js | 20 + .eslintrc.json | 3 - .github/workflows/deploy.yml | 214 + .gitignore | 39 +- .gitpod.Dockerfile | 9 + .gitpod.yml | 48 + .husky/.gitignore | 1 - .husky/pre-commit | 4 - .npmrc | 1 + .prettierignore | 7 + .prettierrc | 10 - CONTRIBUTING.md | 62 - Dockerfile | 88 +- LICENSE | 674 -- README.md | 199 +- {src => app}/components/BoxedContent.tsx | 0 {src => app}/components/CustomHead.tsx | 6 +- {src => app}/components/Footer.tsx | 0 {src => app}/components/Header.tsx | 0 {src => app}/components/Layout.tsx | 6 +- app/components/Nav.tsx | 74 + app/components/VideoList/VideoList.tsx | 179 + .../components/VideoPlayer/VideoPlayer.tsx | 34 +- app/entry.client.tsx | 22 + app/entry.server.tsx | 53 + .../images/banner-tube-archivist-dark.png | Bin .../images/banner-tube-archivist-light.png | Bin .../images/default-channel-banner.jpg | Bin {src => app}/images/default-channel-icon.jpg | Bin {src => app}/images/default-video-thumb.jpg | Bin {src => app}/images/icon-add.svg | 0 {src => app}/images/icon-close.svg | 0 {src => app}/images/icon-download.svg | 0 {src => app}/images/icon-exit.svg | 0 {src => app}/images/icon-eye.svg | 0 {src => app}/images/icon-gear.svg | 0 {src => app}/images/icon-gridview.svg | 0 {src => app}/images/icon-listview.svg | 0 {src => app}/images/icon-play.svg | 0 {src => app}/images/icon-rescan.svg | 0 {src => app}/images/icon-search.svg | 0 {src => app}/images/icon-seen.svg | 0 {src => app}/images/icon-sort.svg | 0 {src => app}/images/icon-star-empty.svg | 0 {src => app}/images/icon-star-full.svg | 0 {src => app}/images/icon-star-half.svg | 0 {src => app}/images/icon-stop.svg | 0 {src => app}/images/icon-thumb.svg | 0 {src => app}/images/icon-unseen.svg | 0 .../images/logo-tube-archivist-dark.png | Bin .../images/logo-tube-archivist-light.png | Bin app/lib/constants.server.ts | 3 + app/lib/constants.ts | 2 + app/lib/getChannels.ts | 48 + {src => app}/lib/getDownloads.ts | 86 +- app/lib/getPlaylists.ts | 67 + {src => app}/lib/getVideos.ts | 20 +- {src => app}/lib/utils.ts | 0 app/root.tsx | 60 + app/routes/channel/$id.tsx | 145 + app/routes/channel/index.tsx | 181 + app/routes/download.tsx | 525 + app/routes/index.tsx | 43 + app/routes/playlist/$id.tsx | 191 + .../routes/playlist/index.tsx | 139 +- .../[videoId].tsx => app/routes/video/$id.tsx | 61 +- app/session.server.ts | 97 + {src => app}/styles/dark.css | 0 {src => app}/styles/globals.css | 231 +- {src => app}/styles/light.css | 0 app/types/Videos.ts | 136 + {src => app}/types/channel.ts | 10 +- app/types/channels.ts | 106 + {src => app}/types/download.ts | 0 app/types/playlist.ts | 104 + app/types/playlistVideos.ts | 138 + {src => app}/types/playlists.ts | 0 app/utils.test.ts | 13 + app/utils.ts | 71 + assets/tube-archivist-banner.jpg | Bin 49837 -> 0 bytes .../tube-archivist-ibracorp-O8H8Z01c0Ys.jpg | Bin 116107 -> 0 bytes assets/tube-archivist-logo-dark.jpg | Bin 81833 -> 0 bytes assets/tube-archivist-logo-dark.png | Bin 22376 -> 0 bytes assets/tube-archivist-logo-light.jpg | Bin 85131 -> 0 bytes assets/tube-archivist-logo-light.png | Bin 22565 -> 0 bytes assets/tube-archivist-screenshot-channels.png | Bin 133766 -> 0 bytes assets/tube-archivist-screenshot-download.png | Bin 80752 -> 0 bytes assets/tube-archivist-screenshot-home.png | Bin 178506 -> 0 bytes ...be-archivist-screenshot-single-channel.png | Bin 170063 -> 0 bytes assets/tube-archivist-screenshot-video.png | Bin 243844 -> 0 bytes assets/tube-archivist-social-preview.jpg | Bin 52912 -> 0 bytes cypress.config.ts | 27 + cypress/.eslintrc.js | 6 + cypress/e2e/smoke.cy.ts | 51 + cypress/fixtures/example.json | 5 + cypress/support/commands.ts | 95 + cypress/support/create-user.ts | 48 + cypress/support/delete-user.ts | 37 + cypress/support/e2e.ts | 15 + cypress/tsconfig.json | 29 + docker-compose.yml | 57 - fly.toml | 38 + mocks/README.md | 7 + mocks/index.js | 9 + next-env.d.ts | 5 - next.config.js | 9 - package.json | 105 +- public/favicon.ico | Bin 25931 -> 16958 bytes public/favicon/android-chrome-192x192.png | Bin 2351 -> 0 bytes public/favicon/android-chrome-512x512.png | Bin 8602 -> 0 bytes .../apple-touch-icon-114x114-precomposed.png | Bin 1720 -> 0 bytes public/favicon/apple-touch-icon-114x114.png | Bin 1376 -> 0 bytes .../apple-touch-icon-120x120-precomposed.png | Bin 1753 -> 0 bytes public/favicon/apple-touch-icon-120x120.png | Bin 1425 -> 0 bytes .../apple-touch-icon-144x144-precomposed.png | Bin 2149 -> 0 bytes public/favicon/apple-touch-icon-144x144.png | Bin 1677 -> 0 bytes .../apple-touch-icon-152x152-precomposed.png | Bin 2183 -> 0 bytes public/favicon/apple-touch-icon-152x152.png | Bin 1685 -> 0 bytes .../apple-touch-icon-180x180-precomposed.png | Bin 2822 -> 0 bytes public/favicon/apple-touch-icon-180x180.png | Bin 2212 -> 0 bytes .../apple-touch-icon-57x57-precomposed.png | Bin 920 -> 0 bytes public/favicon/apple-touch-icon-57x57.png | Bin 747 -> 0 bytes .../apple-touch-icon-60x60-precomposed.png | Bin 1012 -> 0 bytes public/favicon/apple-touch-icon-60x60.png | Bin 830 -> 0 bytes .../apple-touch-icon-72x72-precomposed.png | Bin 1095 -> 0 bytes public/favicon/apple-touch-icon-72x72.png | Bin 891 -> 0 bytes .../apple-touch-icon-76x76-precomposed.png | Bin 1180 -> 0 bytes public/favicon/apple-touch-icon-76x76.png | Bin 959 -> 0 bytes .../favicon/apple-touch-icon-precomposed.png | Bin 2822 -> 0 bytes public/favicon/apple-touch-icon.png | Bin 2212 -> 0 bytes public/favicon/browserconfig.xml | 9 - public/favicon/favicon-16x16.png | Bin 1373 -> 0 bytes public/favicon/favicon-32x32.png | Bin 2783 -> 0 bytes public/favicon/favicon.ico | Bin 15086 -> 0 bytes public/favicon/mstile-150x150.png | Bin 2094 -> 0 bytes public/favicon/safari-pinned-tab.svg | 100 - public/favicon/site.webmanifest | 19 - public/font/OFL_License.txt | 94 + public/font/Sen-Bold.woff | Bin 0 -> 29084 bytes public/font/Sen-Regular.woff | Bin 0 -> 28936 bytes public/img/icon-substract.svg | 75 + public/js/cast-videos.js | 148 - public/js/progress.js | 106 - public/js/script.js | 912 -- public/vercel.svg | 4 - remix.config.js | 7 + remix.env.d.ts | 2 + renovate.json | 4 - server.ts | 70 + src/components/Nav.tsx | 95 - src/components/VideoList/VideoList.tsx | 223 - src/components/VideoList/index.ts | 4 - src/components/VideoPlayer/index.tsx | 4 - src/lib/constants.ts | 12 - src/lib/getChannels.ts | 23 - src/lib/getPlaylists.ts | 55 - src/pages/_app.tsx | 26 - src/pages/_document.tsx | 20 - src/pages/api/auth/[...nextauth].ts | 93 - src/pages/auth/login.tsx | 78 - src/pages/channel.tsx | 233 - src/pages/download.tsx | 420 - src/pages/index.tsx | 46 - src/types/next-auth.d.ts | 18 - src/types/playlist.ts | 103 - src/types/video.ts | 124 - src/types/videos.ts | 153 - tailwind.config.js | 8 + test/setup-test-env.ts | 4 + tsconfig.json | 34 +- vitest.config.ts | 15 + yarn.lock | 8663 +++++++++++++++-- 177 files changed, 11428 insertions(+), 5484 deletions(-) delete mode 100644 .devcontainer/Dockerfile delete mode 100644 .devcontainer/devcontainer.json create mode 100644 .env.example delete mode 100644 .env.local.example create mode 100644 .eslintrc.js delete mode 100644 .eslintrc.json create mode 100644 .github/workflows/deploy.yml create mode 100644 .gitpod.Dockerfile create mode 100644 .gitpod.yml delete mode 100644 .husky/.gitignore delete mode 100755 .husky/pre-commit create mode 100644 .npmrc create mode 100644 .prettierignore delete mode 100644 .prettierrc delete mode 100644 CONTRIBUTING.md delete mode 100644 LICENSE rename {src => app}/components/BoxedContent.tsx (100%) rename {src => app}/components/CustomHead.tsx (96%) rename {src => app}/components/Footer.tsx (100%) rename {src => app}/components/Header.tsx (100%) rename {src => app}/components/Layout.tsx (68%) create mode 100644 app/components/Nav.tsx create mode 100644 app/components/VideoList/VideoList.tsx rename {src => app}/components/VideoPlayer/VideoPlayer.tsx (79%) create mode 100644 app/entry.client.tsx create mode 100644 app/entry.server.tsx rename {src => app}/images/banner-tube-archivist-dark.png (100%) rename {src => app}/images/banner-tube-archivist-light.png (100%) rename {src => app}/images/default-channel-banner.jpg (100%) rename {src => app}/images/default-channel-icon.jpg (100%) rename {src => app}/images/default-video-thumb.jpg (100%) rename {src => app}/images/icon-add.svg (100%) rename {src => app}/images/icon-close.svg (100%) rename {src => app}/images/icon-download.svg (100%) rename {src => app}/images/icon-exit.svg (100%) rename {src => app}/images/icon-eye.svg (100%) rename {src => app}/images/icon-gear.svg (100%) rename {src => app}/images/icon-gridview.svg (100%) rename {src => app}/images/icon-listview.svg (100%) rename {src => app}/images/icon-play.svg (100%) rename {src => app}/images/icon-rescan.svg (100%) rename {src => app}/images/icon-search.svg (100%) rename {src => app}/images/icon-seen.svg (100%) rename {src => app}/images/icon-sort.svg (100%) rename {src => app}/images/icon-star-empty.svg (100%) rename {src => app}/images/icon-star-full.svg (100%) rename {src => app}/images/icon-star-half.svg (100%) rename {src => app}/images/icon-stop.svg (100%) rename {src => app}/images/icon-thumb.svg (100%) rename {src => app}/images/icon-unseen.svg (100%) rename {src => app}/images/logo-tube-archivist-dark.png (100%) rename {src => app}/images/logo-tube-archivist-light.png (100%) create mode 100644 app/lib/constants.server.ts create mode 100644 app/lib/constants.ts create mode 100644 app/lib/getChannels.ts rename {src => app}/lib/getDownloads.ts (64%) mode change 100755 => 100644 create mode 100644 app/lib/getPlaylists.ts rename {src => app}/lib/getVideos.ts (58%) rename {src => app}/lib/utils.ts (100%) create mode 100644 app/root.tsx create mode 100644 app/routes/channel/$id.tsx create mode 100644 app/routes/channel/index.tsx create mode 100644 app/routes/download.tsx create mode 100644 app/routes/index.tsx create mode 100644 app/routes/playlist/$id.tsx rename src/pages/playlist.tsx => app/routes/playlist/index.tsx (53%) rename src/pages/video/[videoId].tsx => app/routes/video/$id.tsx (82%) create mode 100644 app/session.server.ts rename {src => app}/styles/dark.css (100%) rename {src => app}/styles/globals.css (88%) mode change 100755 => 100644 rename {src => app}/styles/light.css (100%) create mode 100644 app/types/Videos.ts rename {src => app}/types/channel.ts (94%) create mode 100644 app/types/channels.ts rename {src => app}/types/download.ts (100%) mode change 100755 => 100644 create mode 100644 app/types/playlist.ts create mode 100644 app/types/playlistVideos.ts rename {src => app}/types/playlists.ts (100%) create mode 100644 app/utils.test.ts create mode 100644 app/utils.ts delete mode 100644 assets/tube-archivist-banner.jpg delete mode 100644 assets/tube-archivist-ibracorp-O8H8Z01c0Ys.jpg delete mode 100644 assets/tube-archivist-logo-dark.jpg delete mode 100644 assets/tube-archivist-logo-dark.png delete mode 100644 assets/tube-archivist-logo-light.jpg delete mode 100644 assets/tube-archivist-logo-light.png delete mode 100644 assets/tube-archivist-screenshot-channels.png delete mode 100644 assets/tube-archivist-screenshot-download.png delete mode 100644 assets/tube-archivist-screenshot-home.png delete mode 100644 assets/tube-archivist-screenshot-single-channel.png delete mode 100644 assets/tube-archivist-screenshot-video.png delete mode 100644 assets/tube-archivist-social-preview.jpg create mode 100644 cypress.config.ts create mode 100644 cypress/.eslintrc.js create mode 100644 cypress/e2e/smoke.cy.ts create mode 100644 cypress/fixtures/example.json create mode 100644 cypress/support/commands.ts create mode 100644 cypress/support/create-user.ts create mode 100644 cypress/support/delete-user.ts create mode 100644 cypress/support/e2e.ts create mode 100644 cypress/tsconfig.json delete mode 100644 docker-compose.yml create mode 100644 fly.toml create mode 100644 mocks/README.md create mode 100644 mocks/index.js delete mode 100644 next-env.d.ts delete mode 100644 next.config.js delete mode 100644 public/favicon/android-chrome-192x192.png delete mode 100644 public/favicon/android-chrome-512x512.png delete mode 100644 public/favicon/apple-touch-icon-114x114-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-114x114.png delete mode 100644 public/favicon/apple-touch-icon-120x120-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-120x120.png delete mode 100644 public/favicon/apple-touch-icon-144x144-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-144x144.png delete mode 100644 public/favicon/apple-touch-icon-152x152-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-152x152.png delete mode 100644 public/favicon/apple-touch-icon-180x180-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-180x180.png delete mode 100644 public/favicon/apple-touch-icon-57x57-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-57x57.png delete mode 100644 public/favicon/apple-touch-icon-60x60-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-60x60.png delete mode 100644 public/favicon/apple-touch-icon-72x72-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-72x72.png delete mode 100644 public/favicon/apple-touch-icon-76x76-precomposed.png delete mode 100644 public/favicon/apple-touch-icon-76x76.png delete mode 100644 public/favicon/apple-touch-icon-precomposed.png delete mode 100644 public/favicon/apple-touch-icon.png delete mode 100644 public/favicon/browserconfig.xml delete mode 100644 public/favicon/favicon-16x16.png delete mode 100644 public/favicon/favicon-32x32.png delete mode 100644 public/favicon/favicon.ico delete mode 100644 public/favicon/mstile-150x150.png delete mode 100644 public/favicon/safari-pinned-tab.svg delete mode 100644 public/favicon/site.webmanifest create mode 100644 public/font/OFL_License.txt create mode 100644 public/font/Sen-Bold.woff create mode 100644 public/font/Sen-Regular.woff create mode 100644 public/img/icon-substract.svg delete mode 100644 public/js/cast-videos.js delete mode 100644 public/js/progress.js delete mode 100644 public/js/script.js delete mode 100644 public/vercel.svg create mode 100644 remix.config.js create mode 100644 remix.env.d.ts delete mode 100644 renovate.json create mode 100644 server.ts delete mode 100755 src/components/Nav.tsx delete mode 100644 src/components/VideoList/VideoList.tsx delete mode 100644 src/components/VideoList/index.ts delete mode 100644 src/components/VideoPlayer/index.tsx delete mode 100644 src/lib/constants.ts delete mode 100644 src/lib/getChannels.ts delete mode 100644 src/lib/getPlaylists.ts delete mode 100644 src/pages/_app.tsx delete mode 100644 src/pages/_document.tsx delete mode 100644 src/pages/api/auth/[...nextauth].ts delete mode 100644 src/pages/auth/login.tsx delete mode 100644 src/pages/channel.tsx delete mode 100755 src/pages/download.tsx delete mode 100644 src/pages/index.tsx delete mode 100644 src/types/next-auth.d.ts delete mode 100644 src/types/playlist.ts delete mode 100644 src/types/video.ts delete mode 100644 src/types/videos.ts create mode 100644 tailwind.config.js create mode 100644 test/setup-test-env.ts create mode 100644 vitest.config.ts diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile deleted file mode 100644 index 4594a3a..0000000 --- a/.devcontainer/Dockerfile +++ /dev/null @@ -1,28 +0,0 @@ -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.224.3/containers/python-3/.devcontainer/base.Dockerfile - -# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster -ARG VARIANT="3.10-bullseye" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10 -ARG NODE_VERSION="none" -RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -RUN sed -i 's/required/sufficient/g' /etc/pam.d/chsh - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -COPY tubearchivist/requirements.txt /tmp/pip-tmp/ -RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ - && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ - && apt-get -y install --no-install-recommends fish - -ENV SHELL /usr/bin/fish - -USER vscode -RUN fish -c "curl -sL https://git.io/fisher | source && fisher install jorgebucaran/fisher" - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json deleted file mode 100644 index b95f57b..0000000 --- a/.devcontainer/devcontainer.json +++ /dev/null @@ -1,64 +0,0 @@ -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.3/containers/python-3 -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6 - // Append -bullseye or -buster to pin to an OS version. - // Use -bullseye variants on local on arm64/Apple Silicon. - "VARIANT": "3.10-bullseye", - // Options - "NODE_VERSION": "16" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "python.defaultInterpreterPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint", - "typescript.tsdk": "tubearchivist/www/node_modules/typescript/lib", - "terminal.integrated.defaultProfile.linux": "fish" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - "ms-python.vscode-pylance", - "esbenp.prettier-vscode", - "dbaeumer.vscode-eslint", - "eamodio.gitlens", - "batisteo.vscode-django", - "christian-kohler.path-intellisense", - "quicktype.quicktype" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - "forwardPorts": [3000, 8000], - - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "chsh -s /usr/bin/fish && fish -c 'fisher install matchai/spacefish'", - // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode", - "features": { - // "fish": "latest", - "github-cli": "latest", - "docker-in-docker": { - "version": "latest", - "moby": true - }, - "git": "os-provided" - } -} diff --git a/.dockerignore b/.dockerignore index fc8fbc5..6378aed 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,24 +1,8 @@ -# Git -.git -.gitignore - -# Docker -.docker - -# Python -tubearchivist/__pycache__/ -tubearchivist/*/__pycache__/ -tubearchivist/*/*/__pycache__/ -tubearchivist/*/*/*/__pycache__/ -.env/ -.venv/ -venv/ - -# Unneeded graphics -assets/* - -# Unneeded docs -docs/* - -# for local testing only -testing.sh \ No newline at end of file +/node_modules +*.log +.DS_Store +.env +/.cache +/public/build +/build +Old/ \ No newline at end of file diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..5ac05b6 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +API_URL= +API_KEY= +PUBLIC_API_URL= \ No newline at end of file diff --git a/.env.local.example b/.env.local.example deleted file mode 100644 index 0903fe5..0000000 --- a/.env.local.example +++ /dev/null @@ -1,8 +0,0 @@ -# https://next-auth.js.org/configuration/options#nextauth_secret Used to encrypt JWT -NEXTAUTH_SECRET= - -# https://next-auth.js.org/configuration/options#nextauth_url When deploying to production, set the NEXTAUTH_URL environment variable to the canonical URL of your site. -NEXTAUTH_URL= - -# URL of the Tubearchivist server without a trailing / -NEXT_PUBLIC_TUBEARCHIVIST_URL= \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000..aee6735 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,20 @@ +/** @type {import('@types/eslint').Linter.BaseConfig} */ +module.exports = { + extends: [ + "@remix-run/eslint-config", + "@remix-run/eslint-config/node", + "@remix-run/eslint-config/jest-testing-library", + ], + env: { + "cypress/globals": true, + }, + plugins: ["cypress"], + // we're using vitest which has a very similar API to jest + // (so the linting plugins work nicely), but it means we have to explicitly + // set the jest version. + settings: { + jest: { + version: 28, + }, + }, +}; diff --git a/.eslintrc.json b/.eslintrc.json deleted file mode 100644 index bffb357..0000000 --- a/.eslintrc.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "next/core-web-vitals" -} diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..0bb4227 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,214 @@ +name: 🚀 Deploy +on: + push: + branches: + - main + - dev + pull_request: {} + +permissions: + actions: write + contents: read + +jobs: + lint: + name: ⬣ ESLint + runs-on: ubuntu-latest + steps: + - name: 🛑 Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.11.0 + + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 16 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + with: + useLockFile: false + + - name: 🔬 Lint + run: npm run lint + + typecheck: + name: ʦ TypeScript + runs-on: ubuntu-latest + steps: + - name: 🛑 Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.11.0 + + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 16 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + with: + useLockFile: false + + - name: 🔎 Type check + run: npm run typecheck --if-present + + vitest: + name: ⚡ Vitest + runs-on: ubuntu-latest + steps: + - name: 🛑 Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.11.0 + + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 16 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + with: + useLockFile: false + + - name: ⚡ Run vitest + run: npm run test -- --coverage + + cypress: + name: ⚫️ Cypress + runs-on: ubuntu-latest + steps: + - name: 🛑 Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.11.0 + + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: 🏄 Copy test env vars + run: cp .env.example .env + + - name: ⎔ Setup node + uses: actions/setup-node@v3 + with: + node-version: 16 + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + with: + useLockFile: false + + - name: 🛠 Setup Database + run: npx prisma migrate reset --force + + - name: ⚙️ Build + run: npm run build + + - name: 🌳 Cypress run + uses: cypress-io/github-action@v4 + with: + start: npm run start:mocks + wait-on: "http://localhost:8811" + env: + PORT: "8811" + + build: + name: 🐳 Build + # only build/deploy main branch on pushes + if: ${{ (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && github.event_name == 'push' }} + runs-on: ubuntu-latest + steps: + - name: 🛑 Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.11.0 + + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: 👀 Read app name + uses: SebRollen/toml-action@v1.0.0 + id: app_name + with: + file: "fly.toml" + field: "app" + + - name: 🐳 Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + # Setup cache + - name: ⚡️ Cache Docker layers + uses: actions/cache@v3 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: 🔑 Fly Registry Auth + uses: docker/login-action@v2 + with: + registry: registry.fly.io + username: x + password: ${{ secrets.FLY_API_TOKEN }} + + - name: 🐳 Docker build + uses: docker/build-push-action@v3 + with: + context: . + push: true + tags: registry.fly.io/${{ steps.app_name.outputs.value }}:${{ github.ref_name }}-${{ github.sha }} + build-args: | + COMMIT_SHA=${{ github.sha }} + cache-from: type=local,src=/tmp/.buildx-cache + cache-to: type=local,mode=max,dest=/tmp/.buildx-cache-new + + # This ugly bit is necessary if you don't want your cache to grow forever + # till it hits GitHub's limit of 5GB. + # Temp 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 + + deploy: + name: 🚀 Deploy + runs-on: ubuntu-latest + needs: [lint, typecheck, vitest, cypress, build] + # only build/deploy main branch on pushes + if: ${{ (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && github.event_name == 'push' }} + + steps: + - name: 🛑 Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.11.0 + + - name: ⬇️ Checkout repo + uses: actions/checkout@v3 + + - name: 👀 Read app name + uses: SebRollen/toml-action@v1.0.0 + id: app_name + with: + file: "fly.toml" + field: "app" + + - name: 🚀 Deploy Staging + if: ${{ github.ref == 'refs/heads/dev' }} + uses: superfly/flyctl-actions@1.3 + with: + args: "deploy --app ${{ steps.app_name.outputs.value }}-staging --image registry.fly.io/${{ steps.app_name.outputs.value }}:${{ github.ref_name }}-${{ github.sha }}" + env: + FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} + + - name: 🚀 Deploy Production + if: ${{ github.ref == 'refs/heads/main' }} + uses: superfly/flyctl-actions@1.3 + with: + args: "deploy --image registry.fly.io/${{ steps.app_name.outputs.value }}:${{ github.ref_name }}-${{ github.sha }}" + env: + FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} diff --git a/.gitignore b/.gitignore index 737d872..b9ac30a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,35 +1,14 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. +node_modules -# dependencies -/node_modules -/.pnp -.pnp.js - -# testing -/coverage - -# next.js -/.next/ -/out/ - -# production /build +/public/build +.env -# misc -.DS_Store -*.pem +/cypress/screenshots +/cypress/videos +/prisma/data.db +/prisma/data.db-journal -# debug -npm-debug.log* -yarn-debug.log* -yarn-error.log* -.pnpm-debug.log* +/app/styles/tailwind.css -# local env files -.env*.local - -# vercel -.vercel - -# typescript -*.tsbuildinfo +Old/ \ No newline at end of file diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile new file mode 100644 index 0000000..e52ca2d --- /dev/null +++ b/.gitpod.Dockerfile @@ -0,0 +1,9 @@ +FROM gitpod/workspace-full + +# Install Fly +RUN curl -L https://fly.io/install.sh | sh +ENV FLYCTL_INSTALL="/home/gitpod/.fly" +ENV PATH="$FLYCTL_INSTALL/bin:$PATH" + +# Install GitHub CLI +RUN brew install gh diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000..f07c562 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,48 @@ +# https://www.gitpod.io/docs/config-gitpod-file + +image: + file: .gitpod.Dockerfile + +ports: + - port: 3000 + onOpen: notify + +tasks: + - name: Restore .env file + command: | + if [ -f .env ]; then + # If this workspace already has a .env, don't override it + # Local changes survive a workspace being opened and closed + # but they will not persist between separate workspaces for the same repo + + echo "Found .env in workspace" + else + # There is no .env + if [ ! -n "${ENV}" ]; then + # There is no $ENV from a previous workspace + # Default to the example .env + echo "Setting example .env" + + cp .env.example .env + else + # After making changes to .env, run this line to persist it to $ENV + # eval $(gp env -e ENV="$(base64 .env | tr -d '\n')") + # + # Environment variables set this way are shared between all your workspaces for this repo + # The lines below will read $ENV and print a .env file + + echo "Restoring .env from Gitpod" + + echo "${ENV}" | base64 -d | tee .env > /dev/null + fi + fi + + - init: npm install + command: npm run setup && npm run dev + +vscode: + extensions: + - ms-azuretools.vscode-docker + - esbenp.prettier-vscode + - dbaeumer.vscode-eslint + - bradlc.vscode-tailwindcss diff --git a/.husky/.gitignore b/.husky/.gitignore deleted file mode 100644 index 31354ec..0000000 --- a/.husky/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_ diff --git a/.husky/pre-commit b/.husky/pre-commit deleted file mode 100755 index 36af219..0000000 --- a/.husky/pre-commit +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -. "$(dirname "$0")/_/husky.sh" - -npx lint-staged diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..521a9f7 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +legacy-peer-deps=true diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..8cb6bcb --- /dev/null +++ b/.prettierignore @@ -0,0 +1,7 @@ +node_modules + +/build +/public/build +.env + +/app/styles/tailwind.css diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index b06c871..0000000 --- a/.prettierrc +++ /dev/null @@ -1,10 +0,0 @@ -{ - "printWidth": 100, - "tabWidth": 2, - "useTabs": false, - "semi": true, - "singleQuote": false, - "trailingComma": "all", - "bracketSpacing": true, - "arrowParens": "always" -} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index f2538fb..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,62 +0,0 @@ -## Contributing to Tube Archivist - -Welcome, and thanks for showing interest in improving Tube Archivist! -If you haven't already, the best place to start is the README. This will give you an overview on what the project is all about. - -## Report a bug - -If you notice something is not working as expected, check to see if it has been previously reported in the [open issues](https://github.com/tubearchivist/tubearchivist/issues). -If it has not yet been disclosed, go ahead and create an issue. -If the issue doesn't move forward due to a lack of response, I assume it's solved and will close it after some time to keep the list fresh. - -## Wiki - -The wiki is where all user functions are explained in detail. These pages are mirrored into the **docs** folder of the repo. This allows for pull requests and all other features like regular code. Make any changes there, and I'll sync them with the wiki tab. - -## Development Environment - -I have learned the hard way, that working on a dockerized application outside of docker is very error prone and in general not a good idea. So if you want to test your changes, it's best to run them in a docker testing environment. - -This is my setup I have landed on, YMMV: -- Clone the repo, work on it with your favorite code editor in your local filesystem. *testing* branch is the where all the changes are happening, might be unstable and is WIP. -- Then I have a VM on KVM hypervisor running standard Ubuntu Server LTS with docker installed. The VM keeps my projects separate and offers convenient snapshot functionality. The VM also offers ways to simulate lowend environments by limiting CPU cores and memory. But you could also just run docker on your host system. -- The `Dockerfile` is structured in a way that the actual application code is in the last layer so rebuilding the image with only code changes utilizes the build cache for everything else and will just take a few seconds. -- Take a look at the `deploy.sh` file. I have my local DNS resolve `tubearchivist.local` to the IP of the VM for convenience. To deploy the latest changes and rebuild the application to the testing VM run: -```bash -./deploy.sh test -``` -- The command above will call the docker build command with `--build-arg INSTALL_DEBUG=1` to install additional useful debug tools. -- The `test` argument takes another optional argument to build for a specific architecture valid options are: `amd64`, `arm64` and `multi`, default is `amd64`. -- This `deploy.sh` file is not meant to be universally usable for every possible environment but could serve as an idea on how to automatically rebuild containers to test changes - customize to your liking. - -## Working with Elasticsearch -Additionally to the required services as listed in the example docker-compose file, the **Dev Tools** of [Kibana](https://www.elastic.co/guide/en/kibana/current/docker.html) are invaluable for running and testing Elasticsearch queries. - -If you want to run queries in on the Elasticsearch container directly from your host with for example `curl` or something like *postman*, you might want to **publish** the port 9200 instead of just **exposing** it. - -## Implementing a new feature - -Do you see anything on the roadmap that you would like to take a closer look at but you are not sure, what's the best way to tackle that? Or anything not on there yet you'd like to implement but are not sure how? Open up an issue and we try to find a solution together. - -## Making changes - -To fix a bug or implement a feature, fork the repository and make all changes to the testing branch. When ready, create a pull request. - -## Releases - -There are three different docker tags: -- **latest**: As the name implies is the latest multiarch release for regular usage. -- **unstable**: Intermediate amd64 builds for quick testing and improved collaboration. Don't mix with a *latest* installation, for your testing environment only. This is untested and WIP and will have breaking changes between commits that might require a reset to resolve. -- **semantic versioning**: There will be a handful named version tags that will also have a matching release and tag on github. - -If you want to see what's in your container, checkout the matching release tag. A merge to **master** usually means a *latest* or *unstable* release. If you want to preview changes in your testing environment, pull the *unstable* tag or clone the repository and build the docker container with the Dockerfile from the **testing** branch. - -## Code formatting and linting - -To keep things clean and consistent for everybody, there is a github action setup to lint and check the changes. You can test your code locally first if you want. For example if you made changes in the **download** module, run - -```shell -./deploy.sh validate tubearchivist/home/src/download.py -``` - -to validate your changes. If you omit the path, all the project files will get checked. This is subject to change as the codebase improves. \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 8f545a1..f472b71 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,80 +1,32 @@ -# multi stage to build tube archivist -# first stage to build python wheel, copy into final image +FROM node:16-bullseye-slim as deps +WORKDIR /myapp -# First stage to build python wheel -FROM python:3.10.4-slim-bullseye AS builder -ARG TARGETPLATFORM +ADD package.json yarn.lock .npmrc ./ +RUN yarn install -RUN apt-get update -RUN apt-get install -y --no-install-recommends build-essential gcc curl +# Build the app +FROM node:16-bullseye-slim as build -# get newest patched ffmpeg and ffprobe builds for amd64 fall back to repo ffmpeg for arm64 -RUN if [ "$TARGETPLATFORM" = "linux/amd64" ] ; then \ - curl -s https://api.github.com/repos/yt-dlp/FFmpeg-Builds/releases/latest \ - | grep browser_download_url \ - | grep ".*master.*linux64.*tar.xz" \ - | cut -d '"' -f 4 \ - | xargs curl -L --output ffmpeg.tar.xz && \ - tar -xf ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffmpeg" && \ - tar -xf ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffprobe" && \ - rm ffmpeg.tar.xz \ - ; elif [ "$TARGETPLATFORM" = "linux/arm64" ] ; then \ - apt-get -y update && apt-get -y install --no-install-recommends ffmpeg && rm -rf /var/lib/apt/lists/* \ - ; fi +WORKDIR /myapp -# install requirements -COPY ./tubearchivist/requirements.txt /requirements.txt -RUN pip install --user -r requirements.txt +COPY --from=deps /myapp/node_modules /myapp/node_modules -# build final image -FROM python:3.10.4-slim-bullseye as tubearchivist +ADD . . +RUN yarn build -ARG TARGETPLATFORM -ARG INSTALL_DEBUG +# Finally, build the production image with minimal footprint +FROM node:16-bullseye-slim -ENV PYTHONUNBUFFERED 1 +ENV PORT="8080" +ENV NODE_ENV="production" -# copy build requirements -COPY --from=builder /root/.local /root/.local -COPY --from=builder /usr/bin/ffmpeg /usr/bin/ffmpeg -COPY --from=builder /usr/bin/ffprobe /usr/bin/ffprobe -ENV PATH=/root/.local/bin:$PATH +WORKDIR /myapp -# install distro packages needed -RUN apt-get clean && apt-get -y update && apt-get -y install --no-install-recommends \ - nginx \ - atomicparsley \ - curl && rm -rf /var/lib/apt/lists/* +COPY --from=deps /myapp/node_modules /myapp/node_modules -# install debug tools for testing environment -RUN if [ "$INSTALL_DEBUG" ] ; then \ - apt-get -y update && apt-get -y install --no-install-recommends \ - vim htop bmon net-tools iputils-ping procps \ - && pip install --user ipython \ - ; fi +COPY --from=build /myapp/build /myapp/build +COPY --from=build /myapp/public /myapp/public +COPY --from=build /myapp/package.json /myapp/package.json -# make folders -RUN mkdir /cache -RUN mkdir /youtube -RUN mkdir /app - -# copy config files -COPY docker_assets/nginx.conf /etc/nginx/sites-available/default - -# copy application into container -COPY ./tubearchivist /app -COPY ./docker_assets/run.sh /app -COPY ./docker_assets/uwsgi.ini /app - -# volumes -VOLUME /cache -VOLUME /youtube - -# start -WORKDIR /app -EXPOSE 8000 - -RUN chmod +x ./run.sh - -CMD ["./run.sh"] +ENTRYPOINT [ "yarn", "start" ] diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 94a9ed0..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index 6fede4e..94b8809 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,180 @@ -# Tube Archivist Frontend +# Remix Indie Stack -This repo is WIP, recreation of [Tube Archivist](https://github.com/tubearchivist/tubearchivist) frontend in NextJS/React. +![The Remix Indie Stack](https://repository-images.githubusercontent.com/465928257/a241fa49-bd4d-485a-a2a5-5cb8e4ee0abf) -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +Learn more about [Remix Stacks](https://remix.run/stacks). -## Setup your environment -Copy *.env.local.example* to *.env.local* and set: -- **NEXTAUTH_SECRET**: Some long random string -- **NEXTAUTH_URL**: Your frontend, most likely `http://localhost:3000` -- **NEXT_PUBLIC_TUBEARCHIVIST_URL**: Your Tube Archivist backend testing server, e.g. `http://localhost:8000` - -In general: Use the [unstable builds](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#releases) from Tube Archivist or build the image yourself from *testing* branch. - -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev +``` +npx create-remix@latest --template remix-run/indie-stack ``` -### Errors: -- *next command not found*: Install next with `npm install next` -- *Error: Invalid src prop [...] hostname [...] is not configured under images in your `next.config.js`*: Add the *NEXT_PUBLIC_TUBEARCHIVIST_URL* to the list of *domains*. -- *CORS errors in console*: Set the environment variable `DISABLE_CORS=True` to the Tube Archivist container to circumvent this protection. NEVER do that on network accessible installation. +## What's in the stack -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +- [Fly app deployment](https://fly.io) with [Docker](https://www.docker.com/) +- Production-ready [SQLite Database](https://sqlite.org) +- Healthcheck endpoint for [Fly backups region fallbacks](https://fly.io/docs/reference/configuration/#services-http_checks) +- [GitHub Actions](https://github.com/features/actions) for deploy on merge to production and staging environments +- Email/Password Authentication with [cookie-based sessions](https://remix.run/docs/en/v1/api/remix#createcookiesessionstorage) +- Database ORM with [Prisma](https://prisma.io) +- Styling with [Tailwind](https://tailwindcss.com/) +- End-to-end testing with [Cypress](https://cypress.io) +- Local third party request mocking with [MSW](https://mswjs.io) +- Unit testing with [Vitest](https://vitest.dev) and [Testing Library](https://testing-library.com) +- Code formatting with [Prettier](https://prettier.io) +- Linting with [ESLint](https://eslint.org) +- Static Types with [TypeScript](https://typescriptlang.org) -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. +Not a fan of bits of the stack? Fork it, change it, and use `npx create-remix --template your/repo`! Make it your own. -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. +## Quickstart -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +Click this button to create a [Gitpod](https://gitpod.io) workspace with the project set up and Fly pre-installed -## Learn More +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) -To learn more about Next.js, take a look at the following resources: +## Development -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +- This step only applies if you've opted out of having the CLI install dependencies for you: -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! + ```sh + npx remix init + ``` -## Deploy on Vercel +- Initial setup: _If you just generated this project, this step has been done for you._ -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. + ```sh + npm run setup + ``` -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +- Start dev server: + + ```sh + npm run dev + ``` + +This starts your app in development mode, rebuilding assets on file changes. + +The database seed script creates a new user with some data you can use to get started: + +- Email: `rachel@remix.run` +- Password: `racheliscool` + +### Relevant code: + +This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes. + +- creating users, and logging in and out [./app/models/user.server.ts](./app/models/user.server.ts) +- user sessions, and verifying them [./app/session.server.ts](./app/session.server.ts) +- creating, and deleting notes [./app/models/note.server.ts](./app/models/note.server.ts) + +## Deployment + +This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments. + +Prior to your first deployment, you'll need to do a few things: + +- [Install Fly](https://fly.io/docs/getting-started/installing-flyctl/) + +- Sign up and log in to Fly + + ```sh + fly auth signup + ``` + + > **Note:** If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run `fly auth whoami` and ensure the email matches the Fly account signed into the browser. + +- Create two apps on Fly, one for staging and one for production: + + ```sh + fly apps create my-remix-app-f962 + fly apps create my-remix-app-f962-staging + ``` + + > **Note:** Make sure this name matches the `app` set in your `fly.toml` file. Otherwise, you will not be able to deploy. + + - Initialize Git. + + ```sh + git init + ``` + +- Create a new [GitHub Repository](https://repo.new), and then add it as the remote for your project. **Do not push your app yet!** + + ```sh + git remote add origin + ``` + +- Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with the name `FLY_API_TOKEN`. + +- Add a `SESSION_SECRET` to your fly app secrets, to do this you can run the following commands: + + ```sh + fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app my-remix-app-f962 + fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app my-remix-app-f962-staging + ``` + + If you don't have openssl installed, you can also use [1password](https://1password.com/password-generator/) to generate a random secret, just replace `$(openssl rand -hex 32)` with the generated secret. + +- Create a persistent volume for the sqlite database for both your staging and production environments. Run the following: + + ```sh + fly volumes create data --size 1 --app my-remix-app-f962 + fly volumes create data --size 1 --app my-remix-app-f962-staging + ``` + +Now that everything is set up you can commit and push your changes to your repo. Every commit to your `main` branch will trigger a deployment to your production environment, and every commit to your `dev` branch will trigger a deployment to your staging environment. + +### Connecting to your database + +The sqlite database lives at `/data/sqlite.db` in your deployed application. You can connect to the live database by running `fly ssh console -C database-cli`. + +### Getting Help with Deployment + +If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to [the Fly support community](https://community.fly.io). They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions. + +## GitHub Actions + +We use GitHub Actions for continuous integration and deployment. Anything that gets into the `main` branch will be deployed to production after running tests/build/etc. Anything in the `dev` branch will be deployed to staging. + +## Testing + +### Cypress + +We use Cypress for our End-to-End tests in this project. You'll find those in the `cypress` directory. As you make changes, add to an existing file or create a new file in the `cypress/e2e` directory to test your changes. + +We use [`@testing-library/cypress`](https://testing-library.com/cypress) for selecting elements on the page semantically. + +To run these tests in development, run `npm run test:e2e:dev` which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above. + +We have a utility for testing authenticated features without having to go through the login flow: + +```ts +cy.login(); +// you are now logged in as a new user +``` + +We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file: + +```ts +afterEach(() => { + cy.cleanupUser(); +}); +``` + +That way, we can keep your local db clean and keep your tests isolated from one another. + +### Vitest + +For lower level tests of utilities and individual components, we use `vitest`. We have DOM-specific assertion helpers via [`@testing-library/jest-dom`](https://testing-library.com/jest-dom). + +### Type Checking + +This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run `npm run typecheck`. + +### Linting + +This project uses ESLint for linting. That is configured in `.eslintrc.js`. + +### Formatting + +We use [Prettier](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project. diff --git a/src/components/BoxedContent.tsx b/app/components/BoxedContent.tsx similarity index 100% rename from src/components/BoxedContent.tsx rename to app/components/BoxedContent.tsx diff --git a/src/components/CustomHead.tsx b/app/components/CustomHead.tsx similarity index 96% rename from src/components/CustomHead.tsx rename to app/components/CustomHead.tsx index b116c78..ec4a2b5 100644 --- a/src/components/CustomHead.tsx +++ b/app/components/CustomHead.tsx @@ -1,12 +1,10 @@ -import Head from "next/head"; - /** * TODO: Dynamically get the title * TODO: NextJS recommended pattern for SEO */ export const CustomHead = ({ title }: { title?: string }) => { return ( - + @@ -47,6 +45,6 @@ export const CustomHead = ({ title }: { title?: string }) => { {/* {% else %} */} {/* */} {/* {% endif %} */} - + ); }; diff --git a/src/components/Footer.tsx b/app/components/Footer.tsx similarity index 100% rename from src/components/Footer.tsx rename to app/components/Footer.tsx diff --git a/src/components/Header.tsx b/app/components/Header.tsx similarity index 100% rename from src/components/Header.tsx rename to app/components/Header.tsx diff --git a/src/components/Layout.tsx b/app/components/Layout.tsx similarity index 68% rename from src/components/Layout.tsx rename to app/components/Layout.tsx index 6aaa5f6..b8b89ab 100644 --- a/src/components/Layout.tsx +++ b/app/components/Layout.tsx @@ -1,7 +1,11 @@ import { Footer } from "./Footer"; import { Nav } from "./Nav"; -export const Layout = ({ children }) => { +type Props = { + children: React.ReactNode; +}; + +export const Layout: React.FC = ({ children }) => { return ( <>
diff --git a/app/components/Nav.tsx b/app/components/Nav.tsx new file mode 100644 index 0000000..82172e2 --- /dev/null +++ b/app/components/Nav.tsx @@ -0,0 +1,74 @@ +import BannerDark from "~/images/banner-tube-archivist-dark.png"; +import IconSearch from "~/images/icon-search.svg"; +import IconGear from "~/images/icon-gear.svg"; +import IconExit from "~/images/icon-exit.svg"; +import { Link } from "@remix-run/react"; + +/** TODO: Fix these nav links */ +export const Nav = () => { + return ( +
+
+ + {/* {% if colors == 'dark */} + tube-archivist-banner + {/* {% endif %} */} + {/* {% if colors == 'light */} + {/* tube-archivist-banner */} + {/* {% endif %} */} + +
+
+
+ +
home
+ + +
channels
+ + +
playlists
+ + +
downloads
+ +
+
+ + search-icon + + + gear-icon + + + exit-icon + +
+
+
+ ); +}; diff --git a/app/components/VideoList/VideoList.tsx b/app/components/VideoList/VideoList.tsx new file mode 100644 index 0000000..d0f111a --- /dev/null +++ b/app/components/VideoList/VideoList.tsx @@ -0,0 +1,179 @@ +import { useState } from "react"; +import IconPlay from "~/images/icon-play.svg"; +import type { Videos } from "~/routes/index"; +import type { Datum } from "~/types/Videos"; +import VideoPlayer from "../VideoPlayer/VideoPlayer"; + +type ViewStyle = "grid grid-3" | "list"; + +const VideoList = ({ videos }: { videos: Videos }) => { + const [selectedVideoUrl, setSelectedVideoUrl] = useState(); + const [viewStyle, setViewStyle] = useState("grid grid-3"); + + const handleSelectedVideo = (video: Datum) => { + setSelectedVideoUrl(video); + }; + + const handleRemoveVideoPlayer = () => { + setSelectedVideoUrl(undefined); + }; + + const handleSetViewstyle = (selectedViewStyle: ViewStyle) => { + setViewStyle(selectedViewStyle); + }; + + if (videos.length < 1) { + return ( +
+

No videos found...

+

+ If you've already added a channel or playlist, try going to the{" "} + downloads page to start the scan and download tasks. +

+
+ ); + } + + return ( + <> + + +
+
+

Recent Videos

+
+
+
+ Hide watched: +
+ + {/* {% if not hide_watched %} */} + + {/* {% else %} */} + + {/* {% endif %} */} +
+
+
+
+ Sort by: + + +
+
+
+ sort-icon console.log("showForm")} + id="animate-icon" + /> + handleSetViewstyle("grid grid-3")} + alt="grid view" + /> + handleSetViewstyle("list")} + alt="list view" + /> +
+
+
+ {videos.map((video) => { + return ( +
+
handleSelectedVideo(video)}> +
+
+ video-thumb + {/* {% if video.source.player.progress %} */} +
+ {/* {% else %} */} + {/*
*/} + {/* {% endif %} */} +
+
+ play-icon +
+
+
+
+
+ {video.player.watched ? ( + seen-icon + ) : ( + unseen-icon + )} + + + {video.published} | {video.player.duration_str} + +
+ +
+
+ ); + })} +
+
+ + ); +}; + +export default VideoList; diff --git a/src/components/VideoPlayer/VideoPlayer.tsx b/app/components/VideoPlayer/VideoPlayer.tsx similarity index 79% rename from src/components/VideoPlayer/VideoPlayer.tsx rename to app/components/VideoPlayer/VideoPlayer.tsx index 7214fc3..f33d84f 100644 --- a/src/components/VideoPlayer/VideoPlayer.tsx +++ b/app/components/VideoPlayer/VideoPlayer.tsx @@ -1,15 +1,12 @@ -import NextImage from "next/image"; -import NextLink from "next/link"; -import ReactPlayer from "react-player"; -import IconClose from "../../images/icon-close.svg"; -import { getTAUrl } from "../../lib/constants"; -import { formatNumbers } from "../../lib/utils"; -import { Data } from "../../types/video"; +import { Link } from "@remix-run/react"; +import IconClose from "~/images/icon-close.svg"; +import { formatNumbers } from "~/lib/utils"; -const TA_BASE_URL = getTAUrl(); +const API_URL = + typeof document !== "undefined" ? window.ENV.API_URL : process.env.API_URL; type VideoPlayerProps = { - selectedVideo: Data; + selectedVideo: any; handleRemoveVideoPlayer?: () => void; isHome?: boolean; showStats?: boolean; @@ -21,25 +18,22 @@ const VideoPlayer = ({ isHome = true, showStats = true, }: VideoPlayerProps) => { - if (!selectedVideo) return; return ( <> {selectedVideo && (
- {showStats ? (
- {/* ${playlist} */}
- - -

{selectedVideo.title}

- - + +

{selectedVideo.title}

+
) : null}
diff --git a/app/entry.client.tsx b/app/entry.client.tsx new file mode 100644 index 0000000..1d4ba68 --- /dev/null +++ b/app/entry.client.tsx @@ -0,0 +1,22 @@ +import { RemixBrowser } from "@remix-run/react"; +import { startTransition, StrictMode } from "react"; +import { hydrateRoot } from "react-dom/client"; + +const hydrate = () => { + startTransition(() => { + hydrateRoot( + document, + + + + ); + }); +}; + +if (window.requestIdleCallback) { + window.requestIdleCallback(hydrate); +} else { + // Safari doesn't support requestIdleCallback + // https://caniuse.com/requestidlecallback + window.setTimeout(hydrate, 1); +} diff --git a/app/entry.server.tsx b/app/entry.server.tsx new file mode 100644 index 0000000..7b9fd91 --- /dev/null +++ b/app/entry.server.tsx @@ -0,0 +1,53 @@ +import { PassThrough } from "stream"; +import type { EntryContext } from "@remix-run/node"; +import { Response } from "@remix-run/node"; +import { RemixServer } from "@remix-run/react"; +import isbot from "isbot"; +import { renderToPipeableStream } from "react-dom/server"; + +const ABORT_DELAY = 5000; + +export default function handleRequest( + request: Request, + responseStatusCode: number, + responseHeaders: Headers, + remixContext: EntryContext +) { + const callbackName = isbot(request.headers.get("user-agent")) + ? "onAllReady" + : "onShellReady"; + + return new Promise((resolve, reject) => { + let didError = false; + + const { pipe, abort } = renderToPipeableStream( + , + { + [callbackName]: () => { + const body = new PassThrough(); + + responseHeaders.set("Content-Type", "text/html"); + + resolve( + new Response(body, { + headers: responseHeaders, + status: didError ? 500 : responseStatusCode, + }) + ); + + pipe(body); + }, + onShellError: (err: unknown) => { + reject(err); + }, + onError: (error: unknown) => { + didError = true; + + console.error(error); + }, + } + ); + + setTimeout(abort, ABORT_DELAY); + }); +} diff --git a/src/images/banner-tube-archivist-dark.png b/app/images/banner-tube-archivist-dark.png similarity index 100% rename from src/images/banner-tube-archivist-dark.png rename to app/images/banner-tube-archivist-dark.png diff --git a/src/images/banner-tube-archivist-light.png b/app/images/banner-tube-archivist-light.png similarity index 100% rename from src/images/banner-tube-archivist-light.png rename to app/images/banner-tube-archivist-light.png diff --git a/src/images/default-channel-banner.jpg b/app/images/default-channel-banner.jpg similarity index 100% rename from src/images/default-channel-banner.jpg rename to app/images/default-channel-banner.jpg diff --git a/src/images/default-channel-icon.jpg b/app/images/default-channel-icon.jpg similarity index 100% rename from src/images/default-channel-icon.jpg rename to app/images/default-channel-icon.jpg diff --git a/src/images/default-video-thumb.jpg b/app/images/default-video-thumb.jpg similarity index 100% rename from src/images/default-video-thumb.jpg rename to app/images/default-video-thumb.jpg diff --git a/src/images/icon-add.svg b/app/images/icon-add.svg similarity index 100% rename from src/images/icon-add.svg rename to app/images/icon-add.svg diff --git a/src/images/icon-close.svg b/app/images/icon-close.svg similarity index 100% rename from src/images/icon-close.svg rename to app/images/icon-close.svg diff --git a/src/images/icon-download.svg b/app/images/icon-download.svg similarity index 100% rename from src/images/icon-download.svg rename to app/images/icon-download.svg diff --git a/src/images/icon-exit.svg b/app/images/icon-exit.svg similarity index 100% rename from src/images/icon-exit.svg rename to app/images/icon-exit.svg diff --git a/src/images/icon-eye.svg b/app/images/icon-eye.svg similarity index 100% rename from src/images/icon-eye.svg rename to app/images/icon-eye.svg diff --git a/src/images/icon-gear.svg b/app/images/icon-gear.svg similarity index 100% rename from src/images/icon-gear.svg rename to app/images/icon-gear.svg diff --git a/src/images/icon-gridview.svg b/app/images/icon-gridview.svg similarity index 100% rename from src/images/icon-gridview.svg rename to app/images/icon-gridview.svg diff --git a/src/images/icon-listview.svg b/app/images/icon-listview.svg similarity index 100% rename from src/images/icon-listview.svg rename to app/images/icon-listview.svg diff --git a/src/images/icon-play.svg b/app/images/icon-play.svg similarity index 100% rename from src/images/icon-play.svg rename to app/images/icon-play.svg diff --git a/src/images/icon-rescan.svg b/app/images/icon-rescan.svg similarity index 100% rename from src/images/icon-rescan.svg rename to app/images/icon-rescan.svg diff --git a/src/images/icon-search.svg b/app/images/icon-search.svg similarity index 100% rename from src/images/icon-search.svg rename to app/images/icon-search.svg diff --git a/src/images/icon-seen.svg b/app/images/icon-seen.svg similarity index 100% rename from src/images/icon-seen.svg rename to app/images/icon-seen.svg diff --git a/src/images/icon-sort.svg b/app/images/icon-sort.svg similarity index 100% rename from src/images/icon-sort.svg rename to app/images/icon-sort.svg diff --git a/src/images/icon-star-empty.svg b/app/images/icon-star-empty.svg similarity index 100% rename from src/images/icon-star-empty.svg rename to app/images/icon-star-empty.svg diff --git a/src/images/icon-star-full.svg b/app/images/icon-star-full.svg similarity index 100% rename from src/images/icon-star-full.svg rename to app/images/icon-star-full.svg diff --git a/src/images/icon-star-half.svg b/app/images/icon-star-half.svg similarity index 100% rename from src/images/icon-star-half.svg rename to app/images/icon-star-half.svg diff --git a/src/images/icon-stop.svg b/app/images/icon-stop.svg similarity index 100% rename from src/images/icon-stop.svg rename to app/images/icon-stop.svg diff --git a/src/images/icon-thumb.svg b/app/images/icon-thumb.svg similarity index 100% rename from src/images/icon-thumb.svg rename to app/images/icon-thumb.svg diff --git a/src/images/icon-unseen.svg b/app/images/icon-unseen.svg similarity index 100% rename from src/images/icon-unseen.svg rename to app/images/icon-unseen.svg diff --git a/src/images/logo-tube-archivist-dark.png b/app/images/logo-tube-archivist-dark.png similarity index 100% rename from src/images/logo-tube-archivist-dark.png rename to app/images/logo-tube-archivist-dark.png diff --git a/src/images/logo-tube-archivist-light.png b/app/images/logo-tube-archivist-light.png similarity index 100% rename from src/images/logo-tube-archivist-light.png rename to app/images/logo-tube-archivist-light.png diff --git a/app/lib/constants.server.ts b/app/lib/constants.server.ts new file mode 100644 index 0000000..035f5f8 --- /dev/null +++ b/app/lib/constants.server.ts @@ -0,0 +1,3 @@ +export const API_KEY = + process.env.API_KEY || `1954c006f731df60bf4c9f027d6b7076d699d319`; +export const API_URL = process.env.API_URL || `https://tube.stiforr.tech`; diff --git a/app/lib/constants.ts b/app/lib/constants.ts new file mode 100644 index 0000000..119a3d5 --- /dev/null +++ b/app/lib/constants.ts @@ -0,0 +1,2 @@ +export const API_URL = + typeof document !== "undefined" ? window.ENV.API_URL : process.env.API_URL; diff --git a/app/lib/getChannels.ts b/app/lib/getChannels.ts new file mode 100644 index 0000000..8fee254 --- /dev/null +++ b/app/lib/getChannels.ts @@ -0,0 +1,48 @@ +import type { Channel } from "~/types/channel"; +import type { Channels } from "../types/channels"; +import { API_URL } from "./constants.server"; + +export const getChannels = async (token: string): Promise => { + if (!token) { + throw new Error(`Unable to fetch channels, no token provided`); + } + + const response = await fetch(`${API_URL}/api/channel/`, { + headers: { + Accept: "application/json", + "Content-Type": "application/json", + Authorization: `Token ${token}`, + mode: "no-cors", + }, + }); + if (!response.ok) { + throw new Error("Error getting channel information"); + } + return response.json(); +}; + +export const getChannel = async ( + token: string, + id: string | undefined +): Promise => { + if (!token) { + throw new Error(`Unable to fetch channels, no token provided`); + } + + if (!id) { + throw new Error(`Unable to fetch channel, no id provided`); + } + + const response = await fetch(`${API_URL}/api/channel/${id}`, { + headers: { + Accept: "application/json", + "Content-Type": "application/json", + Authorization: `Token ${token}`, + mode: "no-cors", + }, + }); + if (!response.ok) { + throw new Error("Error getting channel information"); + } + return response.json(); +}; diff --git a/src/lib/getDownloads.ts b/app/lib/getDownloads.ts old mode 100755 new mode 100644 similarity index 64% rename from src/lib/getDownloads.ts rename to app/lib/getDownloads.ts index c317481..ed8cc1d --- a/src/lib/getDownloads.ts +++ b/app/lib/getDownloads.ts @@ -1,22 +1,26 @@ -import { Download, Task, Tasks } from "../types/download"; -import { getTAUrl } from "./constants"; +import type { Download, Task, Tasks } from "../types/download"; - - -const TA_BASE_URL = getTAUrl(); - -export const getDownloads = async (token: string, filter: boolean, pageNumber: number): Promise => { +export const getDownloads = async ( + token: string, + filter: boolean, + pageNumber: number +): Promise => { if (!token) { throw new Error(`Unable to fetch downloads, no token provided.`); } - const response = await fetch(`${TA_BASE_URL.server}/api/download/?filter=${filter ? 'ignore' : 'pending'}&page=${pageNumber}`, { - headers: { - Accept: "application/json", - "Content-Type": "application/json", - Authorization: `Token ${token}`, - mode: "no-cors", - }, - }); + const response = await fetch( + `${API_URL}/api/download/?filter=${ + filter ? "ignore" : "pending" + }&page=${pageNumber}`, + { + headers: { + Accept: "application/json", + "Content-Type": "application/json", + Authorization: `Token ${token}`, + mode: "no-cors", + }, + } + ); if (response.ok) { return response.json(); } else { @@ -32,17 +36,22 @@ export const getDownloads = async (token: string, filter: boolean, pageNumber: n } }; -export const sendDownloads = async (token: string, input: string): Promise => { +export const sendDownloads = async ( + token: string, + input: string +): Promise => { if (!token) { throw new Error(`Unable to send downloads, no token provided.`); } var data = { - "data": [{ - "youtube_id": input, - "status": "pending" - }] + data: [ + { + youtube_id: input, + status: "pending", + }, + ], }; - const response = await fetch(`${TA_BASE_URL.server}/api/download/`, { + const response = await fetch(`${API_URL}/api/download/`, { body: JSON.stringify(data), headers: { Accept: "application/json", @@ -55,18 +64,22 @@ export const sendDownloads = async (token: string, input: string): Promise => { +export const sendDeleteAllQueuedIgnored = async ( + token: string, + filter: string +): Promise => { if (!token) { throw new Error(`Unable to delete downloads, no token provided.`); } - const response = await fetch(`${TA_BASE_URL.server}/api/download/?filter=${filter}`, { + const response = await fetch(`${API_URL}/api/download/?filter=${filter}`, { headers: { Accept: "application/json", "Content-Type": "application/json", @@ -82,11 +95,14 @@ export const sendDeleteAllQueuedIgnored = async (token: string, filter: string): return response.json(); }; -export const sendDeleteVideoQueuedIgnored = async (token: string, videoId: string): Promise => { +export const sendDeleteVideoQueuedIgnored = async ( + token: string, + videoId: string +): Promise => { if (!token) { throw new Error(`Unable to delete downloads, no token provided.`); } - const response = await fetch(`${TA_BASE_URL.server}/api/download/${videoId}/`, { + const response = await fetch(`${API_URL}/api/download/${videoId}/`, { headers: { Accept: "application/json", "Content-Type": "application/json", @@ -102,14 +118,18 @@ export const sendDeleteVideoQueuedIgnored = async (token: string, videoId: strin return response.json(); }; -export const sendMoveVideoQueuedIgnored = async (token: string, videoId: string, status: string): Promise => { +export const sendMoveVideoQueuedIgnored = async ( + token: string, + videoId: string, + status: string +): Promise => { if (!token) { throw new Error(`Unable to move downloads, no token provided.`); } var data = { - "status": status + status: status, }; - const response = await fetch(`${TA_BASE_URL.server}/api/download/${videoId}/`, { + const response = await fetch(`${API_URL}/api/download/${videoId}/`, { body: JSON.stringify(data), headers: { Accept: "application/json", @@ -130,9 +150,9 @@ export const sendTasks = async (token: string, task: Tasks): Promise => { throw new Error(`Unable to start task, no token provided.`); } var data = { - "run": task + run: task, }; - const response = await fetch(`${TA_BASE_URL.server}/api/task/`, { + const response = await fetch(`${API_URL}/api/task/`, { body: JSON.stringify(data), headers: { Accept: "application/json", @@ -146,4 +166,4 @@ export const sendTasks = async (token: string, task: Tasks): Promise => { throw new Error(`Error running task: ${task}.`); } return response.json(); -}; \ No newline at end of file +}; diff --git a/app/lib/getPlaylists.ts b/app/lib/getPlaylists.ts new file mode 100644 index 0000000..a021c96 --- /dev/null +++ b/app/lib/getPlaylists.ts @@ -0,0 +1,67 @@ +import type { Playlist } from "~/types/playlist"; +import type { Playlists } from "~/types/playlists"; +import type { PlaylistVideos } from "~/types/playlistVideos"; +import { API_URL } from "./constants.server"; + +export const getPlaylists = async (token: string): Promise => { + if (!token) { + throw new Error(`No token provided when fetching a playlists`); + } + + const response = await fetch(`${API_URL}/api/playlist/`, { + headers: { + Accept: "application/json", + "Content-Type": "application/json", + Authorization: `Token ${token}`, + mode: "no-cors", + }, + }); + if (!response.ok) { + throw new Error(`Error getting playlists information: ${response.statusText}`); + } + return response.json(); +}; + +export const getPlaylist = async ( + token: string, + playlistId: string | undefined +): Promise => { + if (!token) { + throw new Error(`No token provided when fetching a playlist: ${playlistId}`); + } + + const response = await fetch(`${API_URL}/api/playlist/${playlistId}`, { + headers: { + Accept: "application/json", + "Content-Type": "application/json", + Authorization: `Token ${token}`, + mode: "no-cors", + }, + }); + if (!response.ok) { + throw new Error(`Error getting playlists information: ${response.statusText}`); + } + return response.json(); +}; + +export const getPlaylistVideos = async ( + token: string, + id: string | undefined +): Promise => { + if (!token) { + throw new Error(`No token provided when fetching playlist videos: ${id}`); + } + const response = await fetch(`${API_URL}/api/playlist/${id}/video/`, { + headers: { + Accept: "application/json", + "Content-Type": "application/json", + Authorization: `Token ${token}`, + mode: "no-cors", + }, + }); + + if (!response.ok) { + throw new Error(`Error getting playlist videos: ${response.statusText}`); + } + return response.json(); +}; diff --git a/src/lib/getVideos.ts b/app/lib/getVideos.ts similarity index 58% rename from src/lib/getVideos.ts rename to app/lib/getVideos.ts index b1b4db7..0b099a7 100644 --- a/src/lib/getVideos.ts +++ b/app/lib/getVideos.ts @@ -1,14 +1,11 @@ -import { Video } from "../types/video"; -import { Videos } from "../types/videos"; -import { getTAUrl } from "./constants"; - -const TA_BASE_URL = getTAUrl(); +import type { Datum, Videos } from "~/types/Videos"; +import { API_URL } from "./constants.server"; export const getVideos = async (token: string): Promise => { if (!token) { throw new Error("Missing API token in request to get videos"); } - const response = await fetch(`${TA_BASE_URL.server}/api/video/`, { + const response = await fetch(`${API_URL}/api/video/`, { headers: { Accept: "application/json", "Content-Type": "application/json", @@ -18,20 +15,17 @@ export const getVideos = async (token: string): Promise => { }); if (!response.ok) { - throw new Error("Failed to fetch videos"); + throw new Error(`Failed to fetch videos: ${response.statusText}`); } return response.json(); }; -export const getVideo = async ( - token: string, - videoId: string -): Promise