grapesjs
Advanced tools
Readme
GrapesJS is a free and open source Web Builder Framework which helps building HTML templates, faster and easily, to be delivered in sites, newsletters or mobile apps. Mainly, GrapesJS was designed to be used inside a CMS to speed up the creation of dynamic templates. To better understand this concept check the image below
Generally any 'template system', that you'd find in various applications like CMS, is composed by the structure (HTML), style (CSS) and variables, which are then replaced with other templates and contents on server-side and rendered on client.
This demos show examples of what is possible to achieve:
Webpage Demo - http://grapesjs.com/demo.html
Newsletter Demo - http://grapesjs.com/demo-newsletter-editor.html
| Blocks | Style Manager | Layer Manager |
|---|---|---|
 |  |  |
| Code Viewer | Asset Manager |
|---|---|
 |  |
Local and remote storage
Default built-in commands (basically for creating and managing different components)
https://unpkg.com/grapesjshttps://unpkg.com/grapesjs/dist/css/grapes.min.cssX.X.X with the current version)
https://cdnjs.cloudflare.com/ajax/libs/grapesjs/X.X.X/grapes.min.jshttps://cdnjs.cloudflare.com/ajax/libs/grapesjs/X.X.X/css/grapes.min.cssnpm i grapesjsgit clone https://github.com/GrapesJS/grapesjs.gitFor the development purpose you should follow instructions below.
<link rel="stylesheet" href="path/to/grapes.min.css">
<script src="path/to/grapes.min.js"></script>
<div id="gjs"></div>
<script type="text/javascript">
var editor = grapesjs.init({
container : '#gjs',
components: '<div class="txt-red">Hello world!</div>',
style: '.txt-red{color: red}',
});
</script>
For a more practical example I'd suggest looking up the code inside this demo: http://grapesjs.com/demo.html
Clone the repository and install all the necessary dependencies (yarn is highly recommended)
$ git clone https://github.com/GrapesJS/grapesjs.git
$ cd grapesjs
$ yarn
Start the dev server
$ yarn start
Once the development server is started you should be able to reach the demo page (eg. http://localhost:8080)
Check the getting started guide here: Documentation
API References could be found here: API-Reference
$ yarn test
Official Plugins | Community Plugins
gradient type input to the Style Managerfilter type input to the Style ManagerFind out more about plugins here: Creating plugins
If you like the project and you wish to see it grow, please consider supporting us with a donation of your choice or become a backer/sponsor via Open Collective
Thanks to BrowserStack for providing us browser testing services
BSD 3-clause
FAQs
Free and Open Source Web Builder Framework
The npm package grapesjs receives a total of 39,291 weekly downloads. As such, grapesjs popularity was classified as popular.
We found that grapesjs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.