This is a meta repository for Silex website builder
It includes all projects needed for Silex development as git submodules. This is the repo you need to contribute to Silex as many of the projects are dependencies of each other, so we can iterate in all at the same time and benefit from using Yarn Workspaces or npm workspaces.
To execute a command in every package, use scripts/exec.js ls or npm run exec -- ls
There is no issue on this repo, please use the individual project's issues
Leave the line bellow as it is used in the doc script to insert content in the readme
Auto generated submodules
| Name | Directory | Repo | Description |
|---|---|---|---|
| Silex | packages/Silex |
[email protected]:silexlabs/Silex.git |
Silex is a no-code tool for building websites. It also lets you code when needed. It can be used online, offline or in a JAMStack project. |
| Silex Puter Plugin | packages/silex-puter |
[email protected]:silexlabs/silex-puter.git |
The Silex Puter Plugin brings Silex’s professional website-building capabilities to the Puter environment, letting users create, save, and publish static websites directly in Puter. This plugin enables seamless integration, making it easier than ever to use Silex within Puter for web design and content management. |
| Silex plugins | packages/silex-plugins |
[email protected]:silexlabs/silex-plugins.git |
Environment agnostic (node.js, browser, commonjs, esnext...) open architecture (plugin system) inspired by 11ty.dev config |
| Silex Plugin Starter | packages/silex-plugin-starter |
[email protected]:silexlabs/silex-plugin-starter.git |
A good place to start writing a Silex plugin. It supports server and/or client side plugins, in Javascript and TypeScript. Check Silex developer docs if you need help or join the discussions in the forum |
| Silex Platform by Silex Labs | packages/silex-platform |
[email protected]:silexlabs/silex-platform.git |
This is also a good example on how to customize Silex. And it has a Dockerfile for easy deployment. |
| Silex Dashboard | packages/silex-dashboard |
[email protected]:silexlabs/silex-dashboard.git |
Here is the source code of Silex dashboard. It is a Silex plugin which can be installed to manage websites you will then edit in Silex. |
| Silex CMS | packages/silex-cms |
[email protected]:silexlabs/silex-cms.git |
This is a Silex plugin to make Eleventy layouts visually with integration of any GraphQL API, allowing for a streamlined, code-free development process |
| node_modules Path | packages/node_modules-path |
[email protected]:lexoyo/node_modules-path.git |
Get the path of the node_modules folder in your scripts or CLI or package.json. This is useful when you are building a library that can either be used as an npm dependency or directly, see this question on SO. |
| Grapesjs Ui Suggest Classes | packages/grapesjs-ui-suggest-classes |
[email protected]:silexlabs/grapesjs-ui-suggest-classes.git |
A grapesjs plugin to enable auto-complete of classes in the SelectorManager UI |
| Symbols plugin for GrapesJS | packages/grapesjs-symbols |
[email protected]:silexlabs/grapesjs-sympbols.git |
This plugin adds feature to GrapesJS editor, for users to be able to reuse elements in a website and accross pages |
| Grapesjs Storage Rate Limit | packages/grapesjs-storage-rate-limit |
[email protected]:silexlabs/grapesjs-storage-rate-limit.git |
A plugin for GrapesJS that provides rate-limited storage, allowing you to save changes immediately and then cool down for a specified period before saving again. |
| GrapesJs Notifications Plugin | packages/grapesjs-notifications |
[email protected]:silexlabs/grapesjs-notifications.git |
Why this plugin? GrapesJs is a powerful framework to build no-code tools and allow users to create templates using a drag-and-drop interface. However, the framework does not offer a standard way of notifying users and each plugin implements its own, which is messy and not user friendly. This plugin provides a centralized notification system that can be used by all plugins to display messages to the user. |
| Grapesjs Loading | packages/grapesjs-loading |
[email protected]:silexlabs/grapesjs-loading.git |
Shows a loading bar while the site is loaded or saved. By default it looks like the classic loading bar on top of the page, e.g. on github.com. |
| GrapesJS Keymap Dialog | packages/grapesjs-keymaps-dialog |
[email protected]:silexlabs/grapesjs-keymaps-dialog.git |
This GrapesJS plugin implements a floating UI showing the available keymaps for the editor. |
| Grapesjs Fonts | packages/grapesjs-fonts |
[email protected]:silexlabs/grapesjs-fonts.git |
Custom Fonts plugin for grapesjs |
| Grapesjs Filter Styles | packages/grapesjs-filter-styles |
[email protected]:silexlabs/grapesjs-filter-styles.git |
This plugin adds a search bar in the Style manager so that users can search for a CSS style |
| Grapesjs Directus Storage | packages/grapesjs-directus-storage |
[email protected]:silexlabs/grapesjs-directus-storage.git |
Directus as a backend for GrapesJS |
| GrapesJs Data Source plugin | packages/grapesjs-data-source |
[email protected]:silexlabs/grapesjs-data-source.git |
This GrapesJS plugin integrates various APIs into the editor. |
| GrapesJS Advanced Selector Manager | packages/grapesjs-advanced-selector |
[email protected]:silexlabs/grapesjs-advanced-selector.git |
An advanced selector management plugin for GrapesJS, specifically designed for cases where the default Selector Manager falls short, |
| Expression Input web component | packages/expression-input |
[email protected]:silexlabs/expression-input.git |
A web component to include in your JS/TS projects. Your users can create an expression which is a ordoned list of tokens. It feels like auto completion without typing text. The token can have options too. |
| eleventy-plugin-concat | packages/eleventy-plugin-concat |
[email protected]:silexlabs/eleventy-plugin-concat.git |
Eleventy plugin to bundle your scripts and styles |
Auto generated submodules
To contribute to Silex you need to fork this repo then clone locally this repo with its submodules, make sure you use the required nodejs version (nvm) and install its dependencies (you can replace npm with yarn):
- On github, fork this repo
- Then clone and setup the project:
$ git clone [email protected]:<your github handle>/silex-meta.git --recurse-submodules -j8
$ cd silex-meta
$ nvm install # [optional] Get the node version from .nvmrc
$ npm install # Will install dependencies in all submodules too
$ npm start # Will run the Silex editor from packages/Silex
Then you can open your browser at http://localhost:6800 to see the Silex editor running locally.
When you are ready to contribute to a specific library or libraries, you can do the following:
- On github, fork the libraries you intend to contribute to, e.g.
silex-desktop - In your local clone of this meta repo, update submodule URLs to point to your own forks of each library, e.g:
$ cd packages/silex-desktop $ git remote set-url origin [email protected]:<your-username>/silex-desktop.git'
- Sync Changes: Once your contributions are merged into the main library repositories, they will automatically sync with the meta repository when submodules are updated.
Troubleshooting:
If you find your repositories in a strange state, e.g repositories are on commits instead of the main branch, or if your npm install fails... You can do this:
$ scripts/exec.js "git checkout {{branch}}" # checkout the default branch in all submodules
$ scripts/exec.js "npm install" # install dependencies in all submodules
$ cd packages/Silex && npm run build && cd ../.. # build the Silex editor
Useful commands
- Start Silex:
npm start(or usenpm run start:debug) - Release a package (which is in packages/$PACKAGE_NAME) and bump version of a library and all its dependents:
scripts/release-version packages/$PACKAGE_NAME $VERSION, then you probably want togit push --follow-tagsthe changed packages - Add a project:
git submodules add $PACKAGE_GIT_URL packages/$PACKAGE_NAME, then runnpm run doc - Update
package-lock.jsonfor a particular package:npm i --package-lock-only --workspaces falsein the package directory - Publish a new version of a package:
npm version --patch && git push --follow-tagsin the package directory
- The excellent GrapesJs framework used for the front end drag/drop feature
- Typescript is used to build Silex
- GLYPHICONS library of icons and symbols (CC license) and fontawesome icons
This includes all the packages of this repo.
Auto generated count
> [email protected] count
> cloc packages --exclude-dir node_modules,doc,strapi,test,dist,mock --exclude-ext=md,xml,pug,njk,ini,scss,css,json,svg,yaml,yml,html
100 files
200 files
300 files
400 files
500 files
600 files
646 text files.
classified 296 files
Duplicate file check 296 files (279 known unique)
Unique: 100 files
Unique: 200 files
292 unique files.
Counting: 100
Counting: 200
429 files ignored.
github.com/AlDanial/cloc v 1.96 T=0.50 s (584.0 files/s, 197528.0 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
JavaScript 107 999 2384 63595
TypeScript 175 2057 6043 22495
GraphQL 3 66 6 696
JSX 1 0 2 266
Dockerfile 3 12 9 73
Text 2 8 0 44
liquid 1 0 0 9
-------------------------------------------------------------------------------
SUM: 292 3142 8444 87178
-------------------------------------------------------------------------------
Auto generated count
Cloc's report in mar. 2021:
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
JavaScript 149 9652 10733 54582
JSON 55 3 0 52723
TypeScript 178 2591 4713 21524
HTML 114 16988 380 16689
CSS 57 2142 1098 14399
SCSS 57 881 415 5444
SVG 17 0 0 4810
LESS 36 172 203 4039
YAML 38 18 46 2607
EJS 28 40 9 1627
JSX 14 160 109 1406
Markdown 42 472 0 1067
Pug 17 54 36 938
Dockerfile 1 3 3 9
Properties 1 1 0 1
-------------------------------------------------------------------------------
SUM: 804 33177 17745 181865
-------------------------------------------------------------------------------
Cloc's report in feb 2023:
$ cloc packages
515 text files.
345 unique files.
697 files ignored.
github.com/AlDanial/cloc v 1.92 T=1.00 s (345.0 files/s, 212776.0 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
JSON 22 1 0 119875
JavaScript 62 7190 7805 38240
TypeScript 142 2035 4067 17106
CSS 21 594 715 5761
YAML 23 53 39 2914
LESS 21 138 159 2234
Markdown 15 413 0 932
Pug 14 49 30 899
EJS 7 35 4 798
HTML 3 56 12 495
SVG 13 0 0 96
Dockerfile 2 9 9 13
-------------------------------------------------------------------------------
SUM: 345 10573 12840 189363
-------------------------------------------------------------------------------