README.md

Rotion

Description   |    Demonstration   |    Requirements   |    Technologies   |    Layout   |    Usage

Report bug · Request feature

Description

This project is a desktop application inspired by the popular productivity tool Notion. Developed using Electron and TypeScript, this application replicates basic functionalities for note-taking and text editing, with support for markdown.

The main goal of this project was to explore the Electron framework, investigating its capabilities for building cross-platform desktop applications, as well as leveraging the TipTap library to create a rich and integrated text editing experience.

Demonstration

Rotion.-.Demonstration.mp4

Requirements

• Nodejs
• Npm
• Pnpm

Technologies

• Electron
• Typescript
• TailwindCSS
• Tiptap
• Cmdk
• Electron Store
• Phosphor React
• Eslint
  • @rocketseat/eslint-config

Layout

You can view the project layout via this link.

Usage

You can clone it on your pc using the command:

git clone https://github.com/Lissone/rotion.git
cd rotion

Install dependencies using:

pnpm install
#or
npm install

Run application:

pnpm dev
#or
npm run dev

License

Distributed under the MIT License. See LICENSE for more information.

Made with ❤️ by Lissone

---