best way to save what you love
Svelte collaborationdownloaderinstagramjavascriptmusicredditsocial-mediasoundcloudsveltetiktoktwittertypescriptvideovimeovkwebappyoutubeyoutube-downloader
web/README: update for cobalt 11, add acknowledgments
jj11520ccdf7e5
diff --git a/web/README.md b/web/README.mdindex c528f6e5..81c7362a 100644--- a/web/README.md+++ b/web/README.md@@ -3,18 +3,20 @@ the cobalt frontend is a static web app built with[sveltekit](https://kit.svelte.dev/) + [vite](https://vitejs.dev/).## configuring-- to run a dev environment, run `pnpm run dev`.-- to make a release build of the frontend, run `pnpm run build`.+- to run the dev environment, run `pnpm run dev`.+- to make the release build of the frontend, run `pnpm run build`.## environment variablesthe frontend has several build-time environment variables for configuring various features. to usethem, you must specify them when building the frontend (or running a vite server for development).-| name | example | description |-|:---------------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|-| `WEB_HOST` | `cobalt.tools` | domain on which the frontend will be running. used for meta tags and configuring plausible. |-| `WEB_PLAUSIBLE_HOST` | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. |-| `WEB_DEFAULT_API` | `https://api.cobalt.tools/` | changes url which is used for api requests by frontend clients. |+`WEB_DEFAULT_API` is **required** to run cobalt frontend.++| name | example | description |+|:---------------------|:----------------------------|:--------------------------------------------------------------------------------------------|+| `WEB_HOST` | `cobalt.tools` | domain on which the frontend will be running. used for meta tags and configuring plausible. |+| `WEB_PLAUSIBLE_HOST` | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. |+| `WEB_DEFAULT_API` | `https://api.cobalt.tools/` | changes url which is used for api requests by frontend clients. |\* don't use plausible.io as receiver backend unless you paid for their cloud service.use your own domain when hosting community edition of plausible. refer to their [docs](https://plausible.io/docs) when needed.@@ -38,7 +40,29 @@ you are allowed to host an ***unmodified*** instance of cobalt with branding forwhen making an alternative version of the project, please replace or remove all branding (including the name).-## 3rd party licenses-- [Fluent Emoji by Microsoft](https://github.com/microsoft/fluentui-emoji) (used in cobalt) is under [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.-- [Noto Sans Mono](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/) fonts (used in cobalt) are licensed under the [OFL](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/about) license.+## open source acknowledgments+### svelte + sveltekit+the cobalt frontend is built using [svelte](https://svelte.dev) and [sveltekit](https://svelte.dev/docs/kit/introduction), a really efficient and badass framework, we love it a lot.++### libav.js+our remux and encode workers rely on [libav.js](https://github.com/imputnet/libav.js), which is an optimized build of ffmpeg for the browser. the ffmpeg builds are made up of many components, whose licenses can be found here: [encode](https://github.com/imputnet/libav.js/blob/main/configs/configs/encode/license.js), [remux](https://github.com/imputnet/libav.js/blob/main/configs/configs/remux/license.js).++you can [support ffmpeg here](https://ffmpeg.org/donations.html)!++### fonts, icons and assets+the cobalt frontend uses several different fonts and icon sets.+- [Tabler Icons](https://tabler.io/icons), released under the [MIT](https://github.com/tabler/tabler-icons?tab=MIT-1-ov-file) license.+- [Fluent Emoji by Microsoft](https://github.com/microsoft/fluentui-emoji), released under the [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.+- [Noto Sans Mono](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/) used for the download button, is licensed under the [OFL](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/about) license.+- [IBM Plex Mono](https://fonts.google.com/specimen/IBM+Plex+Mono/) used for all other text, is licensed under the [OFL](https://fonts.google.com/specimen/IBM+Plex+Mono/license) license.+- and the [Redaction](https://redaction.us/) font, which is licensed under the [OFL](https://github.com/fontsource/font-files/blob/main/fonts/other/redaction-10/LICENSE) license (as well as LGPL-2.1).- many update banners were taken from [tenor.com](https://tenor.com/).++### other packages+- [mdsvex](https://github.com/pngwn/MDsveX) to convert the changelogs into svelte components.+- [compare-versions](https://github.com/omichelsen/compare-versions) for sorting the changelogs.+- [svelte-sitemap](https://github.com/bartholomej/svelte-sitemap) for generating a sitemap for the frontend.+- [sveltekit-i18n](https://github.com/sveltekit-i18n/lib) for displaying cobalt in many different languages.+- [vite](https://github.com/vitejs/vite) for building the frontend.++...and many other packages that these packages rely on.