https://github.com/lissone/rotion

A Notion alternative written with Electron.
https://github.com/lissone/rotion

clsx cmdk electron electron-store eslint phosphor-react tailwindcss tiptap typescript

Last synced: about 2 months ago
JSON representation

A Notion alternative written with Electron.

• Host: GitHub
• URL: https://github.com/lissone/rotion
• Owner: Lissone
• Created: 2024-07-10T23:54:42.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-17T21:31:50.000Z (5 months ago)
• Last Synced: 2024-08-17T22:26:31.611Z (5 months ago)
• Topics: clsx, cmdk, electron, electron-store, eslint, phosphor-react, tailwindcss, tiptap, typescript
• Language: TypeScript
• Homepage:
• Size: 1.16 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  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

https://github.com/user-attachments/assets/49dfdd92-6107-48a2-bc80-e9f016c12357

## Requirements

- [Nodejs](https://nodejs.org/en/)

- [Npm](https://www.npmjs.com/)

- [Pnpm](https://pnpm.io)

## 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:

```bash

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

cd rotion

```

Install dependencies using:

```bash

pnpm install

#or

npm install

```

Run application:

```bash

pnpm dev

#or

npm run dev

```

## License

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



  Made with ❤️ by Lissone