Skip to content

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.

Notifications You must be signed in to change notification settings

yeongpin/pin-sticky-notes

Repository files navigation

📝 Pin Sticky Notes

Pin Note Logo

Release License Stars
Downloads

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

FeaturesInstallationTech StackDevelopment

Pin Sticky Notes Preview

✨ 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

# 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 Vue.js
UI Element Plus
State Management Vue.js
Build Tools Vite

📁 Project Structure

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

# 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 file for details.

🙏 Acknowledgments


Made with ❤️ by yeongpin

About

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.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages