https://github.com/hudy9x/kompad

Open source note-taking app for geeks that supports desktop, web, mobile web versions
https://github.com/hudy9x/kompad

note-app reactjs tauri-app

Last synced: about 1 year ago
JSON representation

Open source note-taking app for geeks that supports desktop, web, mobile web versions

• Host: GitHub
• URL: https://github.com/hudy9x/kompad
• Owner: hudy9x
• License: mit
• Created: 2022-05-20T06:52:30.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T14:27:29.000Z (over 1 year ago)
• Last Synced: 2025-04-08T01:35:20.606Z (about 1 year ago)
• Topics: note-app, reactjs, tauri-app
• Language: TypeScript
• Homepage: https://kompad.hudy9x.com
• Size: 1.96 MB
• Stars: 526
• Watchers: 4
• Forks: 43
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Kompad

![App preview](https://github.com/hudy9x/kompad/assets/95471659/f5e532b2-cc8e-4f70-bbfc-f236341cccc9)

This is a simple note-taking app that i built for myself last year. It includes some features as follows:

- File organizations

- Note list

- Folder group

- Tagging

- Autoupdate

- Word counting

- Theme customization

- ...more features. [see here](https://kompad.vercel.app/)

### Techstacks

What i use to build this app

- [Tauri](https://tauri.app/v1/guides/): a toolkit that lets you build desktop app

- Reactjs

- Zustand: the best state management for me now - simple, easy to use

- Firebase

- [Tiptap](https://tiptap.dev/): the main text editor

- [Algolia](https://www.algolia.com/): Fulltext search service

### Installation

If you guys want to use it, please take a look at this [vietnamese instruction](./docs/INSTRUCTION.md) or [english instruction](./docs/INSTRUCTION-EN.md).

### Deploy web version

Or you can try the web version using Vercel Button. However you have to follow the above installation to create project setting on Firebase first. The app requires these config to build.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fhudy9x%2Fkompad%2Ftree%2Fmain&env=REACT_APP_FIREBASE_APP_ID,REACT_APP_FIREBASE_MESSAGE_SENDER_ID,REACT_APP_FIREBASE_STORAGE_BUCKET,REACT_APP_FIREBASE_PROJECT_ID,REACT_APP_FIREBASE_AUTH_DOMAIN,REACT_APP_FIREBASE_API_KEY,REACT_APP_ALGOLIA_APP_ID,REACT_APP_ALGOLIA_API_KEY)

For newbie, go to my setup video on Youtube

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/aBVF-3NE_1Q/0.jpg)](https://www.youtube.com/watch?v=aBVF-3NE_1Q)

### Contributes

Feel free to folk the repo and request a new PR for your refactoring or features