/snipman

An electron app that helps you manage code snippets locally

Primary LanguageJavaScript

Snipman

Snipman is an electron app that makes it easy for you to manage code snippets locally!

Build Status Test Coverage License

NOTE: This app is in active development and is likely to change at short notice. It is not recommended that you use this in any commercial environment.

Requirements

Snipman requires the following:

Quick start

git clone https://github.com/cazwazacz/snipman.git
cd snipman
npm install
npm run setup
npm test

The npm run setup command creates a files directory in the project which the app uses for storing of files. Currently to start working you have to put javascript file in the files directory.

Running the application

To run the application locally, run:

npm start

Contributing

If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.

  1. Fork the repository
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Ensure your changes are tested using Mocha
  6. Create a new Pull Request

License

Snipman is licensed under MIT.