https://github.com/yeongpin/pin-sticky-notes

A modern and elegant sticky notes application built with Electron and Vue.js, featuring a sleek UI, rich text editing, and seamless cross-platform support.
https://github.com/yeongpin/pin-sticky-notes

gui modern notebook notes

Last synced: 5 months ago
JSON representation

A modern and elegant sticky notes application built with Electron and Vue.js, featuring a sleek UI, rich text editing, and seamless cross-platform support.

• Host: GitHub
• URL: https://github.com/yeongpin/pin-sticky-notes
• Owner: yeongpin
• Created: 2025-02-24T09:07:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-25T05:10:58.000Z (over 1 year ago)
• Last Synced: 2025-06-05T17:46:48.509Z (about 1 year ago)
• Topics: gui, modern, notebook, notes
• Language: Vue
• Homepage:
• Size: 232 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# 📝 Pin Sticky Notes





  





  

    

  

  

    

  

  

    

  

  


  

    

  





  A modern and elegant sticky notes application built with Electron and Vue.js





  Features •

  Installation •

  Tech Stack •

  Development







## ✨ Features

- 📝 Create and manage multiple sticky notes

- 🎨 Customizable note colors

- 🌍 Multi-language support (English/Traditional Chinese)

- 🔍 Text zoom functionality

- 🔄 Text translation support

- 📌 Pin notes to top

- 🔔 System tray support

- 💾 Auto-save functionality

- 🌓 Light/Dark theme support

- ⚡ Fast and lightweight

## 🚀 Installation

### System Requirements

| Requirement | Version |

|------------|---------|

| Node.js | ≥ 16.0.0 |

| npm | ≥ 8.0.0 |

### Quick Start

```bash

# Clone the repository

git clone https://github.com/yeongpin/pin-sticky-notes.git

# Navigate to project directory

cd pin-sticky-notes

# Install dependencies

npm install

# Start development server

npm run electron:dev

```

## 🛠 Tech Stack

| Category | Technologies |

|----------|-------------|

| Framework | ![Electron](https://img.shields.io/badge/Electron-47848F?style=flat-square&logo=electron&logoColor=white) ![Vue.js](https://img.shields.io/badge/Vue.js-4FC08D?style=flat-square&logo=vuedotjs&logoColor=white) |

| UI | ![Element Plus](https://img.shields.io/badge/Element_Plus-409EFF?style=flat-square&logo=element&logoColor=white) |

| State Management | ![Vue.js](https://img.shields.io/badge/Vue_Store-4FC08D?style=flat-square&logo=vue.js&logoColor=white) |

| Build Tools | ![Vite](https://img.shields.io/badge/Vite-646CFF?style=flat-square&logo=vite&logoColor=white) |

## 📁 Project Structure

```plaintext

pin-sticky-notes/

├── src/

│   ├── main/          # Main process files

│   ├── preload/       # Preload scripts

│   └── renderer/      # Frontend Vue.js files

│       ├── components/  # Vue components

│       ├── store/       # State management

│       ├── locales/     # i18n translations

│       └── assets/      # Static assets

└── build/            # Build configuration

```

## 🔨 Development

```bash

# Start development

npm run electron:dev

# Build application

npm run build

# Run tests

npm run test

```

## 📄 License

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License - see the [LICENSE](LICENSE.md) file for details.

## 🙏 Acknowledgments

- [Electron](https://www.electronjs.org/)

- [Vue.js](https://vuejs.org/)

- [Element Plus](https://element-plus.org/)

---

Made with ❤️ by yeongpin