Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.14 KB

README.md

File metadata and controls

34 lines (28 loc) · 1.14 KB
Raw

react-code-review-editor

The react-code-review-editor is a React component providing an environment for educational code review purposes. It supports a variety of languages.

review-editor-screenshot

This project was developed as part of a thesis at FH Kiel to be integrated into the CodeFREAK project. The development process included a usability test with students and teachers at said institution to deliver a component with good usability.

Features

  • display syntax highlighted code
  • create and display comments inside the code
  • create and display results
  • different comment types with their own annotation symbols for better usability
  • keyboard shortcuts

Development

For developing and getting to know the components through storybook examples:

git clone https://github.com/codefreak/react-code-review-editor.git
yarn install
yarn storybook

Installation

For using the components:

yarn add react-code-review-editor
yarn install

License

The source code for all packages in ./src is licensed under the MIT license, which you can find in the LICENSE file.