# SnippetStore

**Repository Path**: foxdash/SnippetStore

## Basic Information

- **Project Name**: SnippetStore
- **Description**: :tada: A snippet management app for developers :rocket:
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-07
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align='center'>SnippetStore</h1>
<p align='center'>
<i>:tada: A snippet management app for developers :rocket:</i>
</p>
<p align='center'>
  <a href='https://twitter.com/intent/tweet?text=Wow!&hashtags=SnippetStore&url=https%3A%2F%2Fgithub.com%2FZeroX-DG%2FSnippetStore'>
    <img src="https://img.shields.io/twitter/url/https/github.com/ZeroX-DG/SnippetStore.svg?style=for-the-badge" alt="twitter">
  </a>
</p>
<p align='center'>
<img src='https://travis-ci.org/ZeroX-DG/SnippetStore.svg?branch=master' alt='travis'>
<a href='https://github.com/ZeroX-DG/SnippetStore/releases'>
  <img src='https://badge.fury.io/gh/ZeroX-DG%2FSnippetStore.svg' alt='version'>
</a>
<a href='https://github.com/ZeroX-DG/SnippetStore/releases'>
  <img src='https://img.shields.io/github/downloads/ZeroX-DG/SnippetStore/total.svg' alt='total download'>
</a>
<a href='https://github.com/ZeroX-DG/SnippetStore/stargazers'>
  <img src='https://img.shields.io/github/stars/ZeroX-DG/SnippetStore.svg' alt='stars'>
</a>
<a href='https://github.com/ZeroX-DG/SnippetStore/network'>
  <img src='https://img.shields.io/github/forks/ZeroX-DG/SnippetStore.svg' alt='forks'>
</a>
</p>

<p align='center'>
  <img src='resources/image/intro-gif.gif' />
</p>

## About this project

SnippetStore is an application for developers to store their snippets and quickly retrieve them when needed. SnippetStore mainly focus on storing code therefor its interface is small and simple, perfect for busy developers who doesn't care about small details.

## Donate

There are many requests for macOS support and I'm sure many of you guys who are mac users will want
SnippetStore to be available in homebrew and able to run on macOS too. But in order to do that, I need help from you guys to afford a mac to test & build this project and many more other projects in the future. It would be a huge help if you can buy me a coffee :smile:

<a href="https://www.buymeacoffee.com/hQteV8A" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

SnippetStore is also available on issuehunt

[![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/136717666)

A massive thank you to these donators

| [Trevor Robertson]                                             |
| -------------------------------------------------------------- |
| ![](https://avatars1.githubusercontent.com/u/597601?s=150&v=4) |

## Download

Currently SnippetStore only available for linux and windows.

If you're using MacOS, you can also build a version for you OS too (not guarantee it will work!)

```
npm run dist:mac
```

You can get the latest release of SnippetStore [here](https://github.com/ZeroX-DG/SnippetStore/releases)

## Theme

SnippetStore currently support 2 themes dark and light

| Light theme                                        | Dark theme                                        |
| -------------------------------------------------- | ------------------------------------------------- |
| <img src='resources/image/screenshot-light.png' /> | <img src='resources/image/screenshot-dark.png' /> |

## Tag support

With SnippetStore you can assign multiple tags to your snippet and easy find them using the tag list on the right bar

<p align='center'>
  <img src='resources/image/screenshot-tag.png'>
</p>

## Multi file snippet

Not satisfied with a single file snippet? With SnippetStore you can now store multiple files within a snippet

<p align='center'>
  <img src='resources/image/screenshot-multi-file.png'>
</p>

## Snippet list layout

SnippetStore currently support 2 snippet list layout:

| Original                                                     | List and details                                                    |
| ------------------------------------------------------------ | ------------------------------------------------------------------- |
| <img src='resources/image/screenshot-layout-original.png' /> | <img src='resources/image/screenshot-layout-list-and-detail.png' /> |

## Internalization

SnippetStore currently support 2 languages:

- English
- Vietnamese

## Shortcut

| Action                    | Key                            |
| ------------------------- | ------------------------------ |
| Open create snippet modal | ctrl + n                       |
| Open setting modal        | ctrl + ,                       |
| Toggle small sidebar mode | ctrl + b                       |
| Close all modal           | esc                            |
| Save snippet              | ctrl + s                       |
| Discard snippet changes   | esc                            |
| Navigate in snippet list  | ctrl + pageup, ctrl + pagedown |

## Tech Stack

- Framework: [Electron](https://electronjs.org/)
- Bundler: [Webpack](https://webpack.js.org/), [Babel](https://babeljs.io/), [Electron-builder](https://github.com/electron-userland/electron-builder)
- Language: [JavaScript(ES6)](https://babeljs.io/learn-es2015/), [Sass](http://sass-lang.com/)
- Library: [React](https://reactjs.org/), [MobX](https://mobx.js.org/), [Mousetrap](https://craig.is/killing/mice), [react-toastify](https://fkhadra.github.io/react-toastify/), [react-tooltip](http://wwayne.com/react-tooltip/), [CodeMirror](https://github.com/codemirror/CodeMirror)
- Lint: [ESLint](https://eslint.org/)
- Test: [Jest](https://facebook.github.io/jest/)

## Contributing

Check out [contributing.md](contributing.md)

## Author & Maintainer

- [Hung Nguyen](https://github.com/ZeroX-DG) ([twitter](https://twitter.com/ZeroX_Hung))

## License

- [MIT](LICENSE)

[trevor robertson]: https://github.com/onetrev