Skip to content

πŸš€ A Modern & Efficient Personal Knowledge Management System Built with Electron & Vue.js, this system helps you organize, store, and access your knowledge effortlessly. Designed for speed, flexibility, and productivity, it supports offline access, rich-text editing, and seamless search functionality.

License

Notifications You must be signed in to change notification settings

yeongpin/mine-knowledge-mma

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

48 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

➀ Mine Knowledge MMA

Mine Knowledge Logo

Release License: CC BY-NC-ND 4.0 Stars Downloads

A modern and efficient personal knowledge management system built with Electron and Vue.js.

Download β€’ Features

Mine Knowledge Screenshot

πŸ›  Tech Stack

Category Technologies
Framework Electron Vue.js
UI Element Plus Markdown
State Management Pinia
Development Vite ESLint

✨ Features

Feature Description
πŸ“ Markdown Support Full markdown editing and preview with code highlighting
πŸ—‚ File Management Organize your knowledge with folders and files
πŸ” Quick Search Fast and efficient search through all your notes
πŸ“± Multi-language Support for English and Traditional Chinese
πŸŒ™ Dark Mode Built-in dark mode for comfortable night viewing
πŸ–Ό Image Support Drag & drop image upload with automatic optimization
⭐ Favorites Mark and quickly access your most important notes
πŸ—‘ Trash System Safely delete and restore notes when needed
πŸ“‹ Templates Create notes from predefined templates
πŸ“Š History Tracking Track your recent note modifications
πŸ”„ Auto Save Automatic saving of your work
πŸ’Ύ Local Storage All data stored locally for privacy
πŸ”„ Translation Translate text between multiple languages

πŸš€ Getting Started

System Requirements

Requirement Version
Node.js v16.0.0 or higher
npm/yarn Latest stable version
Git Latest stable version

πŸ› οΈ Development Setup

Clone the repository
git clone https://github.com/yeongpin/mine-knowledge-mma.git
Navigate to the project directory
cd mine-knowledge-mma
Install dependencies
npm install
Start the development server
npm run dev

πŸ“¦ Build Commands

Build for production
npm run build

πŸ“ Project Structure

mine-knowledge-mma/
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ main/          # Main process files
β”‚ β”œβ”€β”€ preload/       # Preload scripts
β”‚ └── renderer/      # Frontend Vue.js files
β”‚   β”œβ”€β”€ components/  # Vue components
β”‚   β”œβ”€β”€ stores/      # Pinia stores
β”‚   └── locales/     # i18n translations
β”œβ”€β”€ public/          # Static assets
└── dist/           # Build output

🀝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

πŸ“„ 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 & Efficient Personal Knowledge Management System Built with Electron & Vue.js, this system helps you organize, store, and access your knowledge effortlessly. Designed for speed, flexibility, and productivity, it supports offline access, rich-text editing, and seamless search functionality.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published