super-charged-rte v1.0.2

super-charged-rte

A modern Rich text editor for all your modern needs.

Installation and usage

1. Fork the repository to your GitHub account.
2. Clone the project to any empty directory

3. Install the packages at two locations

    # super-charged-rte/
    $ npm install
   
    # super-charged-rte/example
    $ npm install

   NOTE: If you are facing issues during installation of packages, delete the package-lock.json file at those two location.

4. Run two server in two separate terminals

     # super-charged-rte/
   $ npm run start
   
   # super-charged-rte/example
   $ npm run start

Documentation

Documentation is available under the folder docs/ and video tutorial is available in this youtube playlist

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull request checklist

Read this section only after you have thoroughly tested your application and want to propagate the changes throughout the team.

1. pull the changes from the upstream master branch

   $ git fetch upstream master
   $ git merge upstream/master

2. Resolve Merge conflicts (if any).

3. Install dependencies that came with the upstream/master.

   # super-charged-rte/
   $ npm install
   
   # super-charged-rte/example
   $ npm install

4. Test the application and fix any bug introduced during the merge.

5. Push the changes to your origin master.

   $ git push

6. Open a pull request from GitHub

For code of conduct and other contribution related information, please refer contributing.md