Skip to content

Commit 21565c7

Browse files
authored
Update README.md
1 parent ebf583f commit 21565c7

File tree

1 file changed

+66
-75
lines changed

1 file changed

+66
-75
lines changed

README.md

Lines changed: 66 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,88 @@
11
# React Design Editor
2-
[![](https://img.shields.io/npm/l/react-design-editor?style=flat-square)](https://en.wikipedia.org/wiki/MIT_License)
3-
[![build](https://github.com/salgum1114/react-design-editor/workflows/build/badge.svg)](https://github.com/salgum1114/react-design-editor/actions)
4-
[![](https://flat.badgen.net/npm/v/react-design-editor?icon=npm)](https://www.npmjs.com/package/react-design-editor)
5-
[![](https://img.shields.io/david/salgum1114/react-design-editor?style=flat-square)](https://david-dm.org/salgum1114/react-design-editor)
6-
[![](https://img.shields.io/david/dev/salgum1114/react-design-editor?style=flat-square)](https://david-dm.org/salgum1114/react-design-editor?type=dev)
2+
[![](https://img.shields.io/npm/l/react-design-editor?style=flat-square)](https://en.wikipedia.org/wiki/MIT_License) [![build](https://github.com/salgum1114/react-design-editor/workflows/build/badge.svg)](https://github.com/salgum1114/react-design-editor/actions) [![](https://flat.badgen.net/npm/v/react-design-editor?icon=npm)](https://www.npmjs.com/package/react-design-editor) [![](https://img.shields.io/david/salgum1114/react-design-editor?style=flat-square)](https://david-dm.org/salgum1114/react-design-editor) [![](https://img.shields.io/david/dev/salgum1114/react-design-editor?style=flat-square)](https://david-dm.org/salgum1114/react-design-editor?type=dev)
3+
4+
React Design Editor is a module for React, written in Javascript/Typescript which provides two primary features:
5+
6+
- Image Editor - Create images in React, draw diagrams and arrange compositions using the image editor and save the result to one of several export formats, provides functionality similar to Powerpoint.
7+
- Business Process Modelling (BPM) - Design flowcharts and process workflows in React and export the model to JSON, which can be imported into the tool (load/save).
8+
9+
The module primarily uses the [Ant Design](https://github.com/ant-design/ant-design/), [Fabric.js](https://github.com/fabricjs/fabric.js) and [React](https://github.com/facebook/react) libraries, but a full list of required dependencies can be found below.
10+
11+
Try it out today - the project is being continually developed to support a variety of different functions.
12+
13+
[View Demo](https://salgum1114.github.io/react-design-editor/)
14+
15+
# Feature List
16+
- [x] Add, remove, resize, reorder, clone, copy/paste and drag/drop elements
17+
- [x] Drawing capability, with polygon, line, arrows and link support
18+
- [x] Preview mode, tooltips, group/ungroup and zoom functionality
19+
- [x] Upload (with drag/drop), import and export to JSON or image
20+
- [x] Image cropping, Image filters, alignment, alignment guides
21+
- [x] Snap to grid, context menu, animation and video element
22+
- [x] Various icons in icon picker and fonts from Google Fonts (20)
23+
- [x] HTML/CSS/JS Element, iFrame element
24+
- [x] Animation support, with Fade / Bounce / Shake / Scaling / Rotation / Flash effects
25+
- [x] Code Editor with HTML / CSS / JS / Preview
26+
- [x] Various interaction modes, including grasp, selection, ctrl + drag grab
27+
- [x] Multiple layouts, with fixed, responsive, fullscreen and grid modes
28+
- [x] SVG, Chart and GIF elements
29+
- [x] Undo/Redo support
30+
- [ ] Wireframes - in development
31+
- [ ] Multiple Map - in development
32+
- [ ] Ruler - in development
733

8-
- React Design Editor has started to develope direct manipulation of editable design tools like Powerpoint, We've developed it with reactjs, ant.design, fabricjs
9-
10-
- Layouts and components such as property edits, item lists, toolbars were developed as react.js and the ant.design component was **primarily** used.
11-
12-
- The project is constantly being developed to support a variety of functions, and its goal is to be able to draw workflow (BPMN) in the future.
34+
# Installation
1335

14-
# Demos
15-
[React Design Editor](https://salgum1114.github.io/react-design-editor/)
36+
Run `npm install react-design-editor` or `yarn add react-design-editor`
1637

17-
# Dependencies
18-
- React.js
19-
- ant.design
20-
- fabric.js
21-
- mediaelement.js
22-
- react-ace
23-
- interact.js
24-
- anime.js
25-
- fontawesome5
26-
- webpack4
27-
- babel
38+
# Getting Started
2839

29-
# Installation
30-
- npm install --save react-design-editor
40+
1. Clone this Project with `git clone https://github.com/salgum1114/react-design-editor.git`
41+
2. Install dependencies with `npm install` or `yarn`
42+
3. Run the App with `npm start` or `yarn start`
43+
4. Open your web browser to `http://localhost:8080`
3144

32-
# Getting Started
33-
- git clone https://github.com/salgum1114/react-design-editor.git - Clone the project
34-
- npm start - Run script
35-
- http://localhost:8080 - Host access
45+
# Screenshots
46+
## Image Map Editor
47+
### 1. Fixed Layout Mode
3648

37-
# Image Map
38-
## Three layout mode
39-
### 1. Fixed
4049
![fixed](https://user-images.githubusercontent.com/19975642/55678049-6aff6180-592e-11e9-8b29-8e1d60df178a.PNG)
4150

42-
### 2. Responsive
51+
### 2. Responsive Layout Mode
52+
4353
![responsive](https://user-images.githubusercontent.com/19975642/55678050-6cc92500-592e-11e9-8a57-c82d371e4be1.PNG)
4454

45-
### 3. Fullscreen
55+
### 3. Full Screen Layout Mode
56+
4657
![fullscreen](https://user-images.githubusercontent.com/19975642/55678051-6dfa5200-592e-11e9-9b9e-b8d8ee3ccb08.PNG)
4758

48-
### Preview mode
59+
### 4. Preview Mode
60+
4961
![preview](https://user-images.githubusercontent.com/19975642/55678052-6fc41580-592e-11e9-9958-9a9be8239bd7.PNG)
5062

51-
# Workflow
52-
![workflow](https://user-images.githubusercontent.com/19975642/55678053-718dd900-592e-11e9-9996-cce9b46d8433.PNG)
63+
## Workflow Editor
5364

54-
# Features
55-
- [x] Add
56-
- [x] Remove
57-
- [x] Resize
58-
- [x] Clone
59-
- [x] Tooltip
60-
- [x] Reorder
61-
- [x] Zoom
62-
- [x] Preview
63-
- [x] Copy & Paste
64-
- [x] Drag & Drop
65-
- [x] Upload (Drag & Drop)
66-
- [x] Alignments
67-
- [x] Drawing - Polygon, Link, Line, Arrow Line
68-
- [x] Export / Import - JSON
69-
- [x] Video Element
70-
- [x] HTML/CSS/JS Element
71-
- [x] iFrame Element
72-
- [x] Code Editor - HTML / CSS / JS / Preview
73-
- [x] Animation - Fade / Bounce / Shake / Scaling / Rotation / Flash
74-
- [x] Icon Chooser - fontawesome 5.2.0 free version
75-
- [x] Google Fonts - 20 fonts
76-
- [x] Align Guidlines - moving
77-
- [x] Interaction Mode - grap / selection / ctrl + drag grab
78-
- [x] Group / Ungroup
79-
- [x] Image Cropping
80-
- [x] Snap To Grid
81-
- [x] Multiple Layout - Fixed / Responsive / Fullscreen / Grid
82-
- [x] Context menu
83-
- [x] Save Image - Canvas, Target Object
84-
- [x] Image Filter
85-
- [x] Undo / Redo
86-
- [x] SVG Element - development (copy)
87-
- [x] Chart Element - development (form)
88-
- [x] GIF Element - development (form)
89-
- [ ] Wireframes - development
90-
- [ ] Multiple Map - development
91-
- [ ] Ruler - development
65+
![workflow](https://user-images.githubusercontent.com/19975642/55678053-718dd900-592e-11e9-9996-cce9b46d8433.PNG)
9266

9367
## ❤️ Sponsors and Backers [![](https://opencollective.com/react-design-editor/tiers/badge.svg)](https://opencollective.com/react-design-editor/contribute) [![](https://opencollective.com/react-design-editor/tiers/sponsor/badge.svg?label=Sponsor&color=brightgreen)](https://opencollective.com/react-design-editor/contribute) [![](https://opencollective.com/react-design-editor/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/react-design-editor/contribute)
9468

69+
[![Sponsored by Workflows for Confluence](https://remote.automation-consultants.com/knowledge/download/attachments/57671882/sponsorship.png)](https://marketplace.atlassian.com/apps/1222276/workflows-for-confluence)
70+
9571
[![](https://opencollective.com/react-design-editor/tiers/sponsor.svg?avatarHeight=36)](https://opencollective.com/react-design-editor/contribute)
9672

9773
[![](https://opencollective.com/react-design-editor/tiers/backer.svg?avatarHeight=36)](https://opencollective.com/react-design-editor/contribute)
74+
75+
# Dependencies
76+
77+
|Dependency|License(s)|
78+
|--|--|
79+
| [React](https://github.com/facebook/react) | MIT |
80+
| [Ant Design](https://github.com/ant-design/ant-design/) | MIT |
81+
| [Fabric.js](https://github.com/fabricjs/fabric.js) | MIT |
82+
| [MediaElement.js](https://github.com/mediaelement/mediaelement) | MIT |
83+
| [React-Ace](https://github.com/securingsincity/react-ace) | MIT |
84+
| [interact.js](https://github.com/taye/interact.js) | MIT |
85+
| [anime.js](https://github.com/juliangarnier/anime/) | MIT |
86+
| [Webpack 4](https://github.com/webpack/webpack) | MIT |
87+
| [Babel](https://github.com/babel/babel) | MIT |
88+
| [fontawesome5](https://github.com/FortAwesome/Font-Awesome) | Icons (CC BY 4.0), Fonts (SIL OFL 1.1), Code (MIT) |

0 commit comments

Comments
 (0)