https://github.com/serlo/cloudflare-worker
Cloudflare worker which works as a proxy for https://serlo.org/
https://github.com/serlo/cloudflare-worker
cloudflare cloudflare-worker serlo service typescript
Last synced: 10 months ago
JSON representation
Cloudflare worker which works as a proxy for https://serlo.org/
- Host: GitHub
- URL: https://github.com/serlo/cloudflare-worker
- Owner: serlo
- License: apache-2.0
- Created: 2020-01-23T21:49:04.000Z (about 6 years ago)
- Default Branch: staging
- Last Pushed: 2025-04-22T07:36:11.000Z (10 months ago)
- Last Synced: 2025-04-22T08:32:04.965Z (10 months ago)
- Topics: cloudflare, cloudflare-worker, serlo, service, typescript
- Language: TypeScript
- Homepage:
- Size: 8.2 MB
- Stars: 9
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# serlo.org – Cloudflare Worker
This repository contains the source code for the cloudflare worker of [Serlo](https://serlo.org/).
## Development
### Helpful commands
- `yarn test` – run all tests
- `yarn lint` – run linter against the codebase
- `yarn check:all` – run all checks (tests and lints)
### Running tests
You can run tests with `yarn test`. We use [jest](https://jestjs.io/) and thus all [jest command line options](https://jestjs.io/docs/en/cli) can be used.
It is also possible to run tests against other environments (the default environment is testing against the local source code):
- `yarn test:staging` – Test against `serlo-staging.dev`
- `yarn test:production` – Test against `serlo.org`
### Write tests
At [`__test__/__utils__`](./__tests__/__utils__) there are utility functions for writing tests:
- [`fetch-helper.ts`](./__tests__/__utils__/fetch-helper.ts):
- `fetchSerlo()` - does an request at the current testing environment. For example when `TEST_ENVIRONMENT=staging` it makes a request at `*.serlo-staging.dev`. Use this function whenever possible. By setting `{ environment: TestEnvironment.Locally }` you can always test against the local environment.
- [`epxect-helper.ts`](./__tests__/__utils__/expect-helper.ts): Various assertation helper you can use.
### Run automatically all checks before pushing
You can use [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to automatically check your codebase before you push. In order to archieve this run the following commands in the root directory:
```sh
echo 'yarn check:all --no-uncommitted-changes' > .git/hooks/pre-push
chmod +x .git/hooks/pre-push
```
You can use the flag `--no-verify` like in `git push --no-verify` to bypass the checks while pushing.
### Show preview of components
In order to show a preview of components you need run `yarn dev` and open `http://127.0.0.1:8787/___cloudflare_worker_dev`. When you want to add your own components for a preview you can add them at [`./src/cloudflare-worker-dev.tsx`](./src/cloudflare-worker-dev.tsx).
## Preview Images
Via `embed.serlo.org/thumbnail?url=${videoUrl|appletUrl}` you can request thumbnail images for supported providers (YouTube, Vimeo, Wikimedia Commons and Geogebra).