# Lepton **Repository Path**: felix_huang/Lepton ## Basic Information - **Project Name**: Lepton - **Description**: Democratizing Snippet Management (macOS/Win/Linux) - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2019-02-27 - **Last Updated**: 2021-02-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![](./docs/img/new_logo.png) [![Build Status](https://travis-ci.org/hackjutsu/Lepton.svg?branch=master)](https://travis-ci.org/hackjutsu/Lepton) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Dependency Status](https://david-dm.org/hackjutsu/Lepton.svg?style=flat-square)](https://david-dm.org/hackjutsu/Lepton) [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/Lepton) [![MIT Licensed](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT) **Lepton** is a lean code snippet manager based on *GitHub Gist*. [Check out its latest release.](https://github.com/hackjutsu/Lepton/releases) - Unlimited public/private snippets - Unlimited tags - Language groups - Markdown support - Jupyter Notebook viewer support - macOS/Win/Linux support - GitHub Enterprise support - Immersive mode - Customizable - Dashboard - Search - Proxy - Free ![Screenshot](./docs/img/portfolio/stay_organized.png) | Organize | Markdown | Jupyter Notebook | | :-------------:| :-----:| :-----: | | ![Screenshot](./docs/img/portfolio/stay_organized.png) | ![Screenshot](./docs/img/portfolio/markdown.png) | ![Screenshot](./docs/img/portfolio/jupyterNotebook.png) | Search (*⇧ + Space*) | Immersive Mode *(⌘/Ctrl + i)* | Dashboard *(⌘/Ctrl + d)* | | :-------------:| :-----:| :-----: | | ![Screenshot](./docs/img/portfolio/search_bar.png) | ![Screenshot](./docs/img/portfolio/immersive.png) | ![Screenshot](./docs/img/portfolio/dashboard.png) ## Shortcuts | Function | Shortcut | Note | | :------------: |:-------------: |:-----:| | New Snippet | `Cmd/Ctrl + N` | Create a snippet | | Edit Snippet | `Cmd/Ctrl + E` | Edit a snippet | | Submit | `Cmd/Ctrl + S` | Submit the changes from the editor | | Cancel | `Cmd/Ctrl + ESC` | Exit the editor without saving | | Sync | `Cmd/Ctrl + R` | Sync with remote Gist server | | Immersive Mode | `Cmd/Ctrl + I` | Toggle the [Immersive mode](https://github.com/hackjutsu/Lepton/blob/master/docs/img/portfolio/immersive.png) | | Dashboard | `Cmd/Ctrl + D` | Toggle the [dashboard](https://github.com/hackjutsu/Lepton/blob/master/docs/img/portfolio/dashboard.png) | | About Page | `Cmd/Ctrl + ,` | Toggle the [About page](https://github.com/hackjutsu/Lepton/blob/dev/docs/img/portfolio/about.png) | | Search | `Shift + Space`| Toggle the [search bar](https://github.com/hackjutsu/Lepton/blob/master/docs/img/portfolio/search_bar.png) | ## Tech Stack ![Based on](./docs/img/erb-logo.png) 1. Framework: [Electron](http://electron.atom.io/) 2. Bundler: [Webpack](http://webpack.github.io/docs/), [Babel](https://babeljs.io), [electron-builder](https://github.com/electron-userland/electron-builder) 3. Language: [ES6](https://babeljs.io/docs/learn-es2015/), [Sass](http://sass-lang.com/) 4. Library: [React](https://facebook.github.io/react/), [Redux](https://github.com/reactjs/redux), [Redux Thunk](https://github.com/gaearon/redux-thunk), [Redux Form](http://redux-form.com/) 5. Lint: [ESLint](http://eslint.org/) ## Installation - Download released binaries(macOS/Windows/Linux) [here](https://github.com/hackjutsu/Lepton/releases). - Install via Homebrew (macOS) ```bash brew cask install lepton ``` ## Development ### Install dependencies ```bash $ git clone git@github.com:hackjutsu/Lepton.git $ cd Lepton && npm i ``` ### Client ID/Secret [Register your application](https://github.com/settings/applications/new), and put your client id and client secret in `./configs/account.js`. ```js module.exports = { client_id: , client_secret: } ``` ### Run ```bash $ npm run build && npm run start ``` ## Build Installer App >Read [electron-builder docs](https://github.com/electron-userland/electron-builder#readme) and check out the [code signing wiki](https://github.com/electron-userland/electron-builder#code-signing) before building the installer app. Build apps for macOS. ```bash $ npm run dist -- -m ``` Build apps for Windows. ```bash $ npm run dist -- -w ``` Build apps for Linux. >Need a running [Docker](https://www.docker.com/) daemon to build a `snap` package. ```bash $ npm run dist -- -l ``` Build apps for macOS, Windows and Linux. ```bash $ npm run dist -- -wml ``` Build apps for the current OS with the current arch. ```bash $ npm run dist ``` ## Configurations Lepton can be configured by `/.leptonrc` in the these fields. (Create the file if it does not exist.) - Snippet - Editor - Logger - Proxy - Enterprise Check out the [.leptonrc template](https://gist.github.com/1ad7e4968eb64d881ec9dedd6c0f400b) to explore their options. ## FAQ [--> Wiki FAQ](https://github.com/hackjutsu/Lepton/wiki/FAQ) ## Contributors
hackjutsu wujysh DNLHC meilinz lcgforever Calinou
rogersachan passerbyid YYSU cixuuz Gisonrg ArLEquiN64
popey tonyxu-io rawrmonstar baybatu
## License MIT © [hackjutsu](https://github.com/hackjutsu)