Skip to content

Silex README Sample (For Review)

Jump to bottom
Jennifer Parker edited this page Jun 14, 2017 · 1 revision

Silex Website Builder

The Silex HTML5 website builder is a free, open-source, browser-based website editor created by Silex Labs. We make it easy to get started by providing templates, widgets, an array of WYSIWYG drag and drop tools, and an intuitive interface. Our built-in HTML, CSS, and JavaScript editors enable full customization and control over your website.

Silex Logo

Table of Contents

Features

  • Easy to use WYSIWYG environment
  • Simple drag and drop tools
  • Built-in HTML, CSS, and JavaScript code editors
  • Free templates and widgets
  • Open source - power to (and from) the people

Getting Started

These instructions will get you set up with a copy of the Silex project on your local machine for development and testing purposes. Remember, these instructions are for developers wishing to help build or improve upon the Silex website builder. If you are a developer or designer wishing to use Silex to build your own website, go to our website builder and start creating!

Clone the Repository

First you'll need to get a local copy of the Silex repository from Github. If you're new to this, follow our step-by-step instructions. Otherwise, follow along here.

Clone the repository. Include the --recursive command to ensure that submodules are cloned. From command line:

$ git clone --recursive https://github.com/<your-username>/Silex.git

Next, navigate to the /Silex root directory of the local repository you just created.

$ cd Silex

Now, select one of the methods below to install.

Install and Run Option 1: Docker (Recommended)

Prerequisites: Docker

Install

First, start Docker.

Next, from command line:

$ docker run -p 6805:6805 silexlabs/silex
Run

Run Silex from the browser of your choosing: http://localhost:6805/

Install and Run Option 2: npm client

Prerequisites:
Linux or Mac - Node.js, npm, Python(v2.7+), Java(v7+)
Windows - Node.js, npm, Python(v2.7+)

Install

From command line:

$ npm install
$ npm run build
Run
$ npm start

Run Silex from the browser of your choosing: http://localhost:6805/

Useful npm commands

  • npm start - starts the server

  • npm run start:debug - starts the server in debug mode

  • npm run build - builds the client-side code (HTML, CSS, JavaScript)

  • npm run build:server - verifies that the server scripts are correct

  • npm run watch:client - runs a build when client-side files change

    These commands are defined in package.json.

Built With

  • Ace - embedded code editor written in JavaScript
  • Cloud Explorer - free customizable file browser and a self-hosted node.js API server
  • GLYPHICONS - library of precisely prepared monochromatic icons and symbols
  • Google Closure Library - JavaScript library for building web applications
  • Google Closure Compiler - tool for improving JavaScript performance
  • jQuery - library that makes using JavaScript for web development easier
  • jQuery UI - curated set of user interaction tools built on jQuery
  • Prodotype - tool that generates UIs for built templates
  • Unifile - Node.js library for accessing cloud storage services with a common API

Contributing

Check out our CONTRIBUTING.md to see how you can submit pull requests to us.

Authors

See the list of contributors who make this project a success. Are you interested in being on this list? Good news - we'd love that! Find out how you can help out.

License

We are licensed under the GNU General Public License.

Additional Links

This is the documentation for Silex website builder. It is a collaborative effort, click edit and start contributing. Also have a look at these discussions.

WARNING: Support for Silex v2 has stopped. Try Silex v3 alpha, Read about it, Subscribe to the newsletter

Clone this wiki locally