GistMate

GistMate is a web application that helps you manage and organize your Gist notes on GitHub. It allows you to easily create, edit, and search for Gist notes, as well as add tags and bookmarks to them for better organization.

With GistMate, you can get the most out of GitHub Gist's reliable and convenient note-taking service. It enhances your Gist experience by adding search, tag, and bookmark features that are not available on the official GitHub Gist website.

Features

• Create, edit, and delete Gist notes on GitHub
• i-18n localization support
  • English
  • Japanese
  • Chinese
• Integrate with GitHub OAuth
• Integrate with lsky-pro self-hosted photo album
• Upload and attach images to your Gists
• Proxy GitHub API to access your Gists esaier and faster
• Search for Gist notes by title, content, or tag
• Tag Gist notes for better organization and management
• Bookmark Gist notes for quick access
• Strong encryption for Gist notes with OpenPGP.js
• Export and import Gist notes for backup

Powerful markdown previewer and editor, powered by vue-markdown-editor

• Image upload
• Tip
• Emoji
• Katex
• Mermaid (flowchart)
• Line Number
• Highlight Lines
• Copy Code
• Align

How to Use

1. Log in with your GitHub account on GistMate or create a gist access key in GitHub developer settings

2. Create and edit your Gist notes

Click the New Gist Collection button on the menu button

Enter the new gist collection name and the first file name

Click the first switch to edit the gist

Use Ctrl+S shortcut Or click save button on the editor or wait for 3 sconds when AutoSave is on or click the first switch on the top tool bar.

Click the first switch again to view your gist

Technologies Used

• GitHub API - RESTful API for accessing GitHub Gist notes
• Vue.js - Front-end JavaScript framework
• vue-i18n - Internationalization plugin for Vue.js
• NodeJS - A JavaScript runtime built on Chrome's V8 JavaScript engine.
• NestJS - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
• vue-markdown-editor - A markdown editor component for Vue.js

Development

To run and develop GistMate on your local machine, follow these steps:

1. Clone the repository: git clone https://github.com/hash070/gistmate.git
2. Enter frontend directory: cd gistmate/frontend
3. Install dependencies: pnpm install
4. Start the development server: pnpm dev

License

GistMate is licensed under the MIT License. See the LICENSE file for more details.