https://github.com/serlo/serlo-editor-lit
Example implementation of the serlo webcomponent editor in a lit environment
https://github.com/serlo/serlo-editor-lit
Last synced: over 1 year ago
JSON representation
Example implementation of the serlo webcomponent editor in a lit environment
- Host: GitHub
- URL: https://github.com/serlo/serlo-editor-lit
- Owner: serlo
- Created: 2024-04-30T21:19:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T17:00:18.000Z (over 1 year ago)
- Last Synced: 2025-01-09T03:14:06.271Z (over 1 year ago)
- Language: JavaScript
- Size: 8.16 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quickstart guide for the @serlo/editor-web-component in lit
[Lit](https://lit.dev/) is a webcomponent framework by Google. The [Serlo Editor](https://www.npmjs.com/package/@serlo/editor-web-component) integrates natively into any environment due to its support for webcomponents. This repo is a minimal barebones example on how to get a Serlo editor started in a lit environment.
Usually, lit is used with TypeScript but to keep the sample small we have opted for the tiniest example possible. All principles apply equally to any other environment that lit can be set up in.
## Usage
1. `yarn`
2. `yarn start`
## Usage with local editor-web-component
1. Clone the frontend repo
2. `cd packages/editor && yarn yalc:publish`
3. `cd ../editor-web-component && yalc add @serlo/editor && yarn yalc:publish`
4. Navigate into this repo and do `yalc add @serlo/editor-web-component && yarn start`