Silex Developer Guide

[DRAFT] Work in progress

Pieces of info are

• In the readme
• https://github.com/silexlabs/Silex/wiki/Contribute

Working with git

You can work on your clone's develop branch otherwise name your branch with a feature name.

During your development, you may need to rebase your work on the latest version of Silex develop branch. To do so you can git stash your changes or commit the work in progress, and then use git pull --rebase upstream develop to get the latest changes of Silex repo. The rerun npm install

Build locally

After cloning the repo, run npm install, which load dependencies and trigger npm run build.

You may want to build the Javascript part with source map: npm run build:js:debug

Create components

Silex components are the elements you can add to a website through the "+" menu.

The components files live in src/prodotype/components/. Each component is made of an HTML template (.ejs file) and a description file in a markdown file (.md).

Components files are compiled with the command npm run build:prodotype

If you add components - thank you! Please make a pull request and after it is merged update the documentation wiki.

Contribute code to the core

Let's discuss it beforehand in an issue please, we will definitely help you.

The projects used by Silex and maintained by the same team

CloudExplorer, unifile and Prodotype are separate projects maintained by the same team. Force Silex to use your local local clones of these projects, use npm link:

$ cd path/to/CloudExplorer/
$ npm link
$ cd path/to/Silex/
$ npm link CloudExplorer

Responsize is another project used by Silex and maintained by us. It is hosted on its own server and acts like a third-party service. When you will do a pull request and it gets merged, it will deploy on the server.

The 3 APIs of Silex

1- Front end API

2- Editor's API

3- Back-end API

Add unifile services (e.g. for hosting companies)

Submit your code

Issue to discuss the feature and implementation

Tests

You need to manually test the behavior of your feature and its effect on the user's website

• In the editor
• Outside the editor in preview
• In the final published website

Pull request

Documentation