Skip to main content

Project setup

Prerequirements​

In order to set up a new Xeditor project, some programs need to be installed on the system. In general, the development of Xeditor can be done on all common operating systems (Windows, Linux, MacOS).

Log in to the package manager​

The Xeditor packages are delivered via a repository. This contains all packages in different versions. You can get a login for this repository from your project manager.

Current repository:​

npm login --registry=https://hub.xeditor.com/repository/xeditor --scope=@xeditor
npm config set @xeditor:registry=https://hub.xeditor.com/repository/xeditor --global

Please note that credentials from https://npm.xeditor.com are no longer valid.

Old repository:​

npm login --registry=https://npm.xeditor.com --scope=@xeditor
npm config set @xeditor:registry=https://npm.xeditor.com --global

Project setup​

Now that we have installed all the necessary Programs and already have access to the packages we can download the template project.

npm pack @xeditor/xeditor-demo
tar -xf *.tar.gz # This command may differ depending on the OS
cd package
npm install

This project itself cannot be started at this point, because important configurations like the schema have not been done yet. These essential configurations will be covered in the next chapters.

Example project​

There is also a sample project where you can see and test the latest features and also use it as a reference for your own implementation. This can be downloaded using the command npm pack @xeditor/xeditor-demo. Afterwards the package can be unzipped and started.

npm pack @xeditor/xeditor-demo
tar -xf *.tar.gz # This command may differ depending on the OS
cd package
npm install
npm run start:develop
## Open your browser and go to http://localhost:7070