z-editor / z-editor

Online Z-notations Editor with Draft.js and React.js

Z-Editor

A tool to create, edit and print formal Z-notation documents.

Try out the Demo.

Table of Contents

• Features
• Getting started
  • Prerequisites
  • Install
  • Build
  • Start
• Todo
• Contributing
• Acknowledgments
• License

Features

• Z-Editor supports following notations in the toolbar,
  • Schemas
  • Logics
  • Sets
  • Relations
  • Functions
  • Sequences
  • Bags
• Download Z-Editor work as a PDF or a ZE file.
• Import a ZE file to the editor and continue work.
• Iconic schemas were created using draft.js blocks.
• Rich Text Utilities.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• git
• npm

Install

git clone https://github.com/Z-Editor/Z-Editor.git
cd Z-Editor
npm install

Build

npm run build

Start

npm run start

Todo

1. Loose the coupling between react-draft-wysiwyg and Z-Editor.
   • Current version of react-draft-wysiwyg doesn't support ref and few other problems were the reasons to add the edited version of react-draft-wysiwyg.

Contributing

• We would greatly appreciate any contribution you make.
• If you have ideas for more functionality or recipes that should be on this project, let us know.

Acknowledgments

• Original repo is from Open-SL.
• Z-Editor is inspired by draft-wysiwyg and react-draft-wysiwyg.

License

Z-Editor is under the MIT license. See the License for more information.

z-editor's Issues

Remove unnecessary CSS in project

right now project has considerable percentage of CSS. and GitHub description shows the project as CSS project (which is not expected for a react project).
task is to identify and remove unnecessary CSS lines from code base.

Feature: Export as PDF or PNG

Need to implement a feature that exports the current document as a PDF or a PNG image.

1. Add an Export button to the top navbar
2. A dropdown menu appears when Export button is active
3. The dropdown menu contains the following
   -PNG
   -PDF
4. On selecting either PNG or PDF, the document is converted to the selected extension and start downloading.

Auto-deploy the tool into z-editor.github.io

right now we are building the project in local after every commit and push the built (updated) version to z-editor.github.io repo.

propose a method to auto deploy the built version of the tool.
you may use travic ci.

help 1
help 2

A save feature would be nice

Could you implement an option to save your work?

Thank you

[Bug] EditorState doesn't update state after uploading a file

Description

downloadState will not update its state after uploading a file unless we start modifying it. A simple use-case is if I uploaded a file, then tried to download it immediately without any modifications, it will download an empty file.

Steps to Reproduce

1. Update the downloadState after immediately uploading the file.

Expected behavior:

• After uploading the file and downloading it immediately without any modifications. It will download the same file again

Actual behavior:

• After uploading the file and downloading it immediately without any modifications. It will download an Empty file.

Include Tests

One missing thing in the repo is test.
please come up with a suitable test cases and scenarios for this react application.

Dependency version update

Description

Bump up all the older node versions to new versions.

import file does not work even for Z files

Prerequisites

• Are you running the latest version?
• Did you check this issue in Issue section?
• Did you check the debugging guide?
• Are you reporting to the correct repository?
• Did you perform a cursory search?

For more information, see the CONTRIBUTING guide.

Description

[Description of the bug or feature]

Steps to Reproduce

1. [First Step]
2. [Second Step]
3. [and so on...]

Expected behavior: [What you expected to happen]

Actual behavior: [What actually happened]

Versions

Please add the browser details with its version.

implement Unit tests for components [etc: react shallow testing]

Since the application is not much heavy shallow testing would be enough.

Fix dependabot security alerts - update dependancies

update node dependencies

Implement the top toolbar seperately

current top tool bar is extracted from an edited version react-draft-wysiwyg project and that made unnecessary coupling between these files.

if we can implement the top tool bar from the scratch we can get rid of that coupling.

Improve README and Documentation to Contribute

Right now we have not enough documentation to help the contributors and users. A nice Documentation for contribution would be a great help for the project.

Idea: Save and Open Z files - [export as a file method]

After writing down a specification, it would be helpful if I could download the specification in a format that I can import back to the editor later on if need be. (May be XML, JSON, etc)

A PDF, while useful for reference purposes, cannot be edited.

Landing Page for the tool

It would be nice to have a landing page and description about project to show the world what we have done. why don't you come up with an innovative idea.

image not working