cobalt/web
2024-09-09 16:38:47 +00:00
..
changelogs web/changelogs: update references from current to main 2024-09-09 16:38:47 +00:00
i18n web/about/community: add community links 2024-09-09 21:19:43 +06:00
src web/svelte: change public prefix to WEB_ 2024-09-09 15:24:23 +00:00
static web/changelogs/10: add changelog banner 2024-09-09 18:27:50 +06:00
.gitignore git: update general gitignore & web gitignore 2024-08-02 21:16:04 +06:00
.npmrc web: project skeleton 2024-06-13 15:32:17 +06:00
eslint.config.js web: add eslint 2024-06-19 17:55:06 +06:00
LICENSE web: add license 2024-07-29 15:26:04 +06:00
package.json web: scope package name 2024-09-09 15:59:40 +00:00
README.md web/README: clarify wording in license permission explanation 2024-09-09 15:46:55 +00:00
svelte.config.js web/svelte: change public prefix to WEB_ 2024-09-09 15:24:23 +00:00
tsconfig.json web: add support for cloudflare turnstile 2024-08-16 00:08:57 +06:00
vite.config.ts web/vite: expose libav.js files directly 2024-08-12 16:47:11 +00:00

cobalt web

the cobalt frontend is a static web app built with sveltekit + vite.

configuring

  • to run a dev environment, run pnpm run dev.
  • to make a release build of the frontend, run pnpm run build.

environment variables

the frontend has several build-time environment variables for configuring various features. to use them, 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_TURNSTILE_KEY 1x00000000000000000000AA cloudflare turnstile public key for antibot protection

* 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 when needed.

license

cobalt web code is licensed under CC-BY-NC-SA-4.0.

this license allows you to:

  • copy and redistribute the code in any medium or format, and
  • remix, transform, use and build upon the code

as long as you:

  • give appropriate credit to the original repo,
  • provide a link to the license and indicate if changes to the code were made,
  • release the code under the same license, and
  • don't use the code for any commercial purposes.

cobalt branding, mascots, and other related assets included in the repo are copyrighted and not covered by the license. you cannot use them under same terms.

you are allowed to host an unmodified instance of cobalt with branding for non-commercial purposes, but this does not give you permission to use the branding anywhere else, or make derivatives of it in any way.

when making an alternative version of the project, please replace or remove all branding (including the name).

3rd party licenses