Edtr.io

A rich text editor for easily creating content in schools based on Slate.js.

🚨 Check it out here: https://schul-cloud.github.io/edtrio/

Getting started

yarn install

This is a yarn workspaces repository, meaning that we have two subrepositories edtrio-client and edtrio-server. In order to start the client, just navigate to edtrio-client and do the following:

yarn start
# go to localhost:3000 if it doesn't open automatically

The server is not absolutely necessary at the moment, but if you want persistence of your documents or communication between clients you should start this as well. Navigate to edtrio-server and run

yarn run startFreshDB
yarn run start
# go to localhost:4000 if it doesn't open automatically

If you want to know more about this and the underlying technology, please visit the docs.

Features

• Hovering menu (bold, italic, underline, code, h1, h2)
• Markdown shortcuts (h1-h5 #, ul -, blockquotes >)
• Button to add Code Blocks
• Button to add Images
• Automatic audio/video link embed (Try pasting e.g. a link to an mp3)
• Video integration (paste youtube/vimeo video link and it'll be auto-converted)

Documentation

The docs can be found here.

Contribute

We very much welcome any kinds of contributions! Have a look at our issue tracker or project board roadmap for inspiration.

• Issue Tracker: https://github.com/schul-cloud/edtrio/issues
• Source Code: https://github.com/schul-cloud/edtrio

For some tooling explanations and guidelines, please head on over to the docs.

Deploying

The editor client is deployed on https://schul-cloud.github.io/edtrio/.
To deploy a new version simply run yarn run deploy in edtrio-client.

License

The project is licensed under the MIT License.