Core development

If you want to help improving Editor.js, follow this guide to prepare local environment and start building.

Before starting

Make sure that you have installed Node.js environment and Yarn package manager. Otherwise you should install them.

You also need Git installed. Check out Atlassian's guide «Install GIt».

Clone the repository

Firstly you need to get sources. Clone the repository via command line.

git clone https://github.com/codex-team/editor.js

Or use buttons on the GitHub page.

Then go to the project's directory.

cd editor.js/

Install dependencies

Get required dependencies by the following command.

yarn install

Then pull submodules.

yarn pull_tools

Ok, you are ready.

Building

Use the following command to build Editor.js. 

yarn build
☝️
Note.
Use this command before commit changes.

On local environment you can run build command in development mode with a watch flag. This way main bundle will be rebuilt on changes automatically.

yarn build:dev

Testing

Open file example/example-dev.html in browser. Editor and Tools will be loaded from local scripts.