# SnipCommand

A free and open source command snippets manager for organize and copy fast.

<p align="center">
  <img src="./public/images/logo/snip_command.png" width="100">
</p>

<p align="center">
  <img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/gurayyarar/SnipCommand">
  <img alt="GitHub" src="https://img.shields.io/github/license/gurayyarar/SnipCommand">
</p>

<p align="center">
  <img src="./documentation/images/preview.png?v=2">
</p>

<p align="center">
    <strong>Built with Electron & React</strong> <br>
    Built for Windows, macOS and Linux
</p>


## Overview
<p align="center">
  <img src="./documentation/images/preview.gif?v=2">
</p>

It helps you create, organize and store your commands (Excel formulas, Sql Queries, Terminal commands, etc.) with dynamic parameters for quick copy to it. Describe your commands with dynamic parameters also support documentation about your snippets. You can select or specify your dynamic values using with selectbox/inputbox for ready to paste the workspace. You can organize with tags.


## Features
- **ORGANIZE WITH TAGS & FAVOURITES** You can organize all commands with tags & favourites system.
- **DESCRIBE DYNAMIC PARAMETERS** You can describe dynamic parameters. Supporting input & selectbox for choosing parameter value.
- **DOCUMENTATION FOR COMMAND** You can describe documentation text for each commands with Markdown Editor.
- **SEARCH** You can quick access your commands
- **AUTOSAVE** Automatically saves any changes you make during work, so you don't have to worry about losing changes.
- **SYNC** You can use any service that provides cloud synchronization, such as iCloud Drive, Google Drive, Dropbox or other similar.
- **DATABASE** We are using [Lowdb - Powered by Lodash](https://github.com/typicode/lowdb) to store your data. The database files are on your local computer.
- **LIGHT/DARK THEME** We are supporting 2 themes.
- And more...



## Contribution
Contribution are always **welcome and recommended!** Here is how:
- Fork the repository [(here is the guide).](https://help.github.com/articles/fork-a-repo/)
- Clone to your machine.

```
git clone https://github.com/YOUR_USERNAME/SnipCommand.git
```


- Install all development packages with `yarn install` command on root.
- Make your changes.
- Create a pull request.


### Build Setup

```
# install dependencies
yarn install

# serve with hot reload
yarn electron-dev

# build electron application for production
yarn release
```

## Releases

Visit the [this link](https://github.com/gurayyarar/SnipCommand/releases)


## Documentation

Visit the [this link](https://github.com/gurayyarar/SnipCommand/blob/master/documentation/DOCUMENTATION.md)

## Change Logs

You can check logs from [this link](https://github.com/gurayyarar/SnipCommand/blob/master/documentation/CHANGELOGS.md)


## License

**SnipCommand** is an open source project that is licensed under the [MIT license](http://opensource.org/licenses/MIT).


## Donations

Donations are **greatly appreciated!**

**[BUY ME A COFFEE](http://bit.ly/2yEjtx5)**