Skip to content

kaiserarg/jottr

Repository files navigation

jottr

jottr is a rich text editor that has features like collaborative editing and git-styled version controlling.

Features

  • Rich Text Editing: Enjoy a full-fledged RTF text editor with support for bold, italics, lists, and more.
  • Collaborative Editing: Work with others in real-time, seeing their changes instantly.
  • Version Control: Keep track of changes with git-styled version controlling, allowing you to revert to previous versions or see the history of edits.
  • Cross-Platform: Available for Windows, macOS, and Linux.

Getting Started

Prerequisites

Make sure you have Node.js installed on your system.

Installation

To install jottr, run the following command in your terminal:

$ npm install

Development

For development purposes, you can start the application in development mode using:

$ npm run dev

This will start a local server with hot reloading enabled, so you can see your changes in real-time.

Building

To create a production-ready build of jottr, use one of the following commands based on your operating system:

For Windows

$ npm run build:win

For macOS

$ npm run build:mac

For Linux

$ npm run build:linux

Contributing

If you'd like to contribute to jottr, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add YourFeature').
  5. Push to the branch (git push origin feature/YourFeature).
  6. Open a pull request.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •