hackjutsu / lepton

💻 Democratizing Snippet Management (macOS/Win/Linux)

Lepton is a lean code snippet manager powered by GitHub Gist. Check out the latest release.

Features

• Unlimited public/secret snippets
• Unlimited tags
• Language groups
• Markdown/JupyterNotebook
• GitHub Enterprise
• GitHub token
• Immersive mode
• Customizable
• Light/Dark theme
• macOS/Win/Linux
• Dashboard
• Search
• Proxy
• Free

Light Theme	Dark Theme

Organize	Markdown	Jupyter Notebook

Search (⇧ + Space)	Immersive Mode (⌘/Ctrl + i)	Dashboard (⌘/Ctrl + d)

Shortcuts

Function	Shortcut	Note
New Snippet	Cmd/Ctrl + N	Create a snippet
Edit Snippet	Cmd/Ctrl + E	Edit a snippet
Delete Snippet	Cmd/Ctrl + Del	Delete selected 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
Dashboard	Cmd/Ctrl + D	Toggle the dashboard
About Page	Cmd/Ctrl + ,	Toggle the About page
Search	Shift + Space	Toggle the search bar

Customization

Lepton's can be customized by <home_dir>/.leptonrc! You can find its exact path in the About page by Command/Ctrl + ,. Create the file if it does not exist.

• Theme (light/dark)
• Snippet
• Editor
• Logger
• Proxy
• Shortcuts
• Enterprise
• Notifications

Check out the configuration docs to explore different customization options.

Tech Stack

1. Framework: Electron
2. Bundler: Webpack, Babel, electron-builder
3. Language: ES6, Sass
4. Library: React, Redux, Redux Thunk, Redux Form
5. Lint: ESLint

Installation

• macOS/Windows/Linux: Download the released packages
• macOS: Install via Homebrew

brew install --cask lepton

• Linux: Install via Snap Store

snap install lepton

Development

Install dependencies

$ git clone https://github.com/hackjutsu/Lepton.git
$ cd Lepton && yarn install

# inspect stale dependencies
$ yarn check-outdated

Client ID/Secret

Register your application, and put your client id and client secret in ./configs/account.js.

module.exports = {
  client_id: <your_client_id>,
  client_secret: <your_client_secret>
}

Run

$ yarn build && yarn start

Build Installer App

Read electron-builder docs and check out the code signing wiki before building the installer app.

Build apps for macOS.

$ yarn dist -m

Build apps for Windows.

$ yarn dist -w

Build apps for Linux.

Need a running Docker daemon to build a snap package.

$ yarn dist -l

Build apps for macOS, Windows and Linux.

$ yarn dist -wml

Build apps for the current OS with the current arch.

$ yarn dist

FAQ

--> Wiki FAQ

Contributors

CosmoX 💻 🎨 ⚠️ 🚧 📦 🤔	Jiaye Wu 💻 🚧 🤔	Danila 💻 🎨 🚧	Meilin Zhan 💻 🤔 🚧	lcgforever 💻	Yuer Lee 📖 📦	Su,Yen-Yun 📖
Chen Tong 💻 🤔 🚧	Jason Jiang 💻	Alan Pope 📦	Tony Xu 📦	Tegan Churchill 💻	Angie Wang 🎨	Batuhan Bayrakci 💻
Samuel Meuli 💻	Alexandre Amado de Castro 💻	Abner Soares Alves Junior 💻	Sean 💻	Ole 💻	Gabriel Nicolas Avellaneda 💻 📖	Dennis Ideler 💻 🤔 📖
Anthony Attard 💻	ArLE 💻	Pol Maresma 💻	PM Extra 💻	Zava 💻	Jason R Alexander 💻	Sebastian Hojas 📖
董雨航 💻	sxyazi 📦	Brian Zalewski 📦

License

MIT © hackjutsu

lepton's Issues

[Unicode search]我们以一个【鸡肋的搜索功能】来庆祝鸡年大吉！！

居然不支持中文。我们以一个鸡肋的搜索功能来庆祝鸡年大吉！！

New feature: delete a gist

Should we support deleting a gist from client?

Moving beyond localStorage?

Might have a better option for local storage.

https://journal.standardnotes.org/moving-beyond-localstorage-991e3695be15#.yz62kzgsu

Unit tests

I don't know how to apply unit tests for a redux app. Help wanted.

New feature: offline mode

As stated in the title... But what's the definition of offline mode?

A minimum implementation would be to save the redux state to disk each time we perform a sync, and initialize the redux with said persistent state(if any) when launch.

Optimize the login process on macOS platform

If the user closes the app on macOS without quitting the main process, and then tries to re-open it by clicking the icon from the dock, the app should automatically login.

Closing the MainWindow when AuthWindow is on could crash the app

The app should exit gracefully.

New feature: local search

It might be nice to have a local search feature.

Migrate to Webpack 2

webpack 2 has significantly reduced the compilation time and simplified the configuration.

webpack 2 release:
https://medium.com/webpack/webpack-2-2-the-final-release-76c3d43bf144#.na4zxwu6a

migration guide:
https://webpack.js.org/guides/migrating/

Display a progress bar when fetching data from network

A progress bar would be much better than a blank page.

activeGist changed after delete a gist

As you can see, active gist changed after gist delete completes.

Snippet thumbnail shows gist description smartly

Currently, the snippet thumbnail shows gist description completely, which sometimes is too long for a thumbnail card.

Proposal:

1. Only pick up the title. However, GitHub Gist doesn't provide the "title" concept in its Gist description section. We need to invent the concept ourselves, like putting the title inside brackets[title] description.
2. Set a maximum lines and truncate the rest.

Display network error

Error should be displayed if the sync or the gist fetching fails.

Right click should show up the context menu

Check out this page: https://github.com/sindresorhus/electron-context-menu

Users would expect the right click to show up the context menu. If it doesn't, users would consider it as a bug.

Auto sync && self-defined sync intervals

Now, Lepton relies on manual sync, i.e., by clicking the #sync button.

Users are asking for the auto sync feature which users can define the sync intervals.

Custom tags support

It would be better if we can apply custom tags to the gist, not just the language tags.

Can't get through to the UI after login when there is a gist without description

In an extreme case, the language tag list goes out of the frame.

In an extreme case, the language tag list goes out of the frame.

Adopt pure ES6

http://es6.ruanyifeng.com/

Speed up the launch

Now it takes about 2s to launch. Reduce the launch time to 0.5s below.

Form validation for edit/new gist form

No blank field is allowed.

Sharing button?

What benefit will it provide if there is a sharing button?

• How
  • Email (Gmail)
  • Embedded link
• Content
  • Plain text/ Rich text
  • Gist link

Prompt out needed when logout

New feature: Notify users whenever there is a new release

Notify the users whenever there is a new version.

ref1
ref2
ref3

I don't find this feature necessary at this moment.

Login Fail

Version:
macOS 10.12.3
Lepton 1.0.0-beta.4

Problem:

After login my github, Lepton give a Sync Sucess notify and show loading progress, But after few seconds, the window change to login page again！

Some Log:

2017-02-04T04:41:14.519Z - info: Found user profile null
2017-02-04T04:41:16.296Z - info: [Dispatch] updateAuthWindowStatus ON
2017-02-04T04:41:34.326Z - info: [Dispatch] updateAuthWindowStatus OFF
2017-02-04T04:41:34.330Z - info: [Dispatch] updateUserSession IN_PROGRESS
2017-02-04T04:41:35.579Z - info: [Dispatch] updateUserSession IN_PROGRESS
2017-02-04T04:41:35.580Z - info: [Dispatch] updateAccessToken
2017-02-04T04:41:38.165Z - debug: The gist number on this page is 6
2017-02-04T04:41:39.134Z - debug: The gist number on this page is 0
2017-02-04T04:41:39.141Z - info: [Dispatch] updateSyncTime
2017-02-04T04:41:39.142Z - info: [Dispatch] updateGists
2017-02-04T04:41:39.142Z - info: [Dispatch] updateGistTags
2017-02-04T04:41:39.144Z - info: [Dispatch] selectGistTag
2017-02-04T04:41:39.145Z - info: [Dispatch] fetchSingleGist 5d84822a5b0d707c53d8
2017-02-04T04:41:39.148Z - info: [Dispatch] selectGist 5d84822a5b0d707c53d8
2017-02-04T04:41:39.149Z - info: [Dispatch] updateUserSession ACTIVE

Refactor .scss files

Mac下关闭主窗口后，再次从Dock启动均会自动发起Sync，可否改为用户自定义Sync 时间间隔

如题

Separate the title and the keyword from the description in the snippet

For a typical gist description,

[Sending IPC events from main to renderer in Electron] (http://stackoverflow.com/a/36809014/3697757) #keywords: electron ipc

we should make it looks nicer in the snippet section:

Sending IPC events from main to renderer in Electron

http://stackoverflow.com/a/36809014/3697757

#keywords: electron ipc

Disable the login button when the AuthWindow shows up

Clicking the login button when the AuthWindow is open could trigger crash. We should just disable the button and show up a welcome image instead.

Sync failed: please check your network connection.

I use Version 1.0.0-beta.3 (1.0.0-beta.3), and CAN connect to Github gist, but this message keep coming, DevTool console told me

Unhandled rejection TypeError: Cannot convert undefined or null to object
    at NavigationPanel.renderLangTags (file:///Applications/Lepton.app/Contents/Resources/app.asar/bundle/app.bundle.js:1962:14)
    at NavigationPanel.renderTagSection (file:///Applications/Lepton.app/Contents/Resources/app.asar/bundle/app.bundle.js:2019:16)
    at NavigationPanel.render (file:///Applications/Lepton.app/Contents/Resources/app.asar/bundle/app.bundle.js:2052:14)
    at /Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:796:21
    at measureLifeCyclePerf (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:75:12)
    at ReactCompositeComponentWrapper._renderValidatedComponentWithoutOwnerOrContext (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:795:25)
    at ReactCompositeComponentWrapper._renderValidatedComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:822:32)
    at ReactCompositeComponentWrapper.performInitialMount (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:362:30)
    at ReactCompositeComponentWrapper.mountComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:258:21)
    at Object.mountComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactReconciler.js:46:35)
    at ReactCompositeComponentWrapper.performInitialMount (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:371:34)
    at ReactCompositeComponentWrapper.mountComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:258:21)
    at Object.mountComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactReconciler.js:46:35)
    at Object.updateChildren (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactChildReconciler.js:121:51)
    at ReactDOMComponent._reconcilerUpdateChildren (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactMultiChild.js:208:32)
    at ReactDOMComponent._updateChildren (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactMultiChild.js:312:31)
    at ReactDOMComponent.updateChildren (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactMultiChild.js:299:12)
    at ReactDOMComponent._updateDOMChildren (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactDOMComponent.js:936:12)
    at ReactDOMComponent.updateComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactDOMComponent.js:754:10)
    at ReactDOMComponent.receiveComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactDOMComponent.js:716:10)
    at Object.receiveComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactReconciler.js:125:22)
    at ReactCompositeComponentWrapper._updateRenderedComponent (/Applications/Lepton.app/Contents/Resources/app.asar/node_modules/react-dom/lib/ReactCompositeComponent.js:754:23)

Cannot use behind a proxy

It will be good if proxy setting is supported.

Show up line number for snippet

Highlight.js, the syntax highlight module currently used, doesn't come with a native line number support.

highlightjs-line-numbers.js, a plugin to address this issue, is based on DOM operation which I don't have much experience with.

Relaunch the app when clicking the icon on Mac

On macOS, if an app is not fully closed, it is expected to open again when the icon is clicked.

App not updated after creating the first gist?

We notice that the app is not updated if the user creates his/her first gist. This issue seems to exist only for the first gist.

Investigate this corner case and fix any bugs if necessary.

The placeholder hint for the filename doesn't show up as expected

Users are confused by this blank field. The hint message doesn't show up as expected to indicate it's for the file name.

In-app notification system

I would like to implement an in-app notification/toast system, rather than calling the OS's specific one.

But this is not a critical issue at this moment.

+国内镜像

如题

代码高亮问题

感谢作者的项目，挺好用的。
发现对Objective-C没有高亮支持，另外Github Gist本身是支持Markdown的，但在Lepton中显示的是纯文本。

Notify the user when token is expired or revoked

The app should fail gracefully and navigate users back to the login dialog.

Search result should be scrollable

AuthWindow should be frameless

The AuthWindow's control bar only complicates the app state management without providing any benefits for either developers and users. Just change it to a frameless window.

Blank page for users without gists...

This looks pale... We can show some dummy stuff.

Navigate to the GitHub page when clicking the profile image

The app should be able to navigate to the GitHub page somehow.

• Maybe by clicking the profile image?

Improve the keyboard binding

http://electron.atom.io/docs/api/menu/

Markdown Rendering

Render the markdown file automatically. This seems to be the most wanted feature.

https://www.npmjs.com/package/marked
https://www.npmjs.com/package/markdown-to-html

Partial search for gists

Should we implement the partial search for gists?
http://fusejs.io/

Currently, we are using ElasticLunr as search engine that only supports full-word.

NEW LOGO!!

At least a new icon...

Consistent order for language tags

They should be sorted alphabetically.

Replace the #null with #Other

Replace the #null with #Other

Enable copy & paste in Electron app

At this moment, the basic copy&paste doesn't work.

https://pracucci.com/atom-electron-enable-copy-and-paste.html