{"id":20038228,"url":"https://github.com/jjcosgrove/frank","last_synced_at":"2026-05-09T05:02:13.275Z","repository":{"id":93586374,"uuid":"84756071","full_name":"jjcosgrove/frank","owner":"jjcosgrove","description":"A minimalist Markdown notes app","archived":false,"fork":false,"pushed_at":"2017-03-15T11:44:40.000Z","size":557,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-02T06:27:41.453Z","etag":null,"topics":["backbone","electron","markdown","nedb","notes","simplemde"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jjcosgrove.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-12T20:43:29.000Z","updated_at":"2020-06-13T15:36:58.000Z","dependencies_parsed_at":"2023-03-07T01:15:24.971Z","dependency_job_id":null,"html_url":"https://github.com/jjcosgrove/frank","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/jjcosgrove/frank","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcosgrove%2Ffrank","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcosgrove%2Ffrank/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcosgrove%2Ffrank/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcosgrove%2Ffrank/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jjcosgrove","download_url":"https://codeload.github.com/jjcosgrove/frank/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcosgrove%2Ffrank/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32807861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backbone","electron","markdown","nedb","notes","simplemde"],"created_at":"2024-11-13T10:26:53.339Z","updated_at":"2026-05-09T05:02:13.257Z","avatar_url":"https://github.com/jjcosgrove.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Frank UI](https://raw.githubusercontent.com/jjcosgrove/frank/master/app/assets/images/frank_ui.jpg)\n\n\\*Devid app icon taken from [Turbomilk](http://www.turbomilk.com)\n\n# Features\n\n* Minimalist interface\n* Shortcut driven\n* Markdown support ([SimpleMDE](https://simplemde.com/))\n* Syntax highlighting ([highlight.js](https://highlightjs.org/))\n* Text-based search (RegEx)\n* Export (JSON)\n* Local data storage ([NeDB](https://github.com/louischatriot/nedb))\n\n# Shortcuts\n\nEverything in Frank is driven by shortcuts. That really is all you need to know*\n\nGlobal shortcut | Action\n:------- | :-----\n*CmdOrCtrl+N* | Add note\n*CmdOrCtrl+D* | Delete note\n*CmdOrCtrl+F* | Search notes (RegEx-based)\n*CmdOrCtrl+E* | Export notes (JSON)\n*CmdOrCtrl+S* | Save note (Markdown)\n*CmdOrCtrl+P* | Toggle preview (see editor shortcut)\n*CmdOrCtrl+Q* | Quit\n\n\u003cbr\u003e\n\nEditor shortcut | Action\n:------- | :-----\n*CmdOrCtrl+'* | toggleBlockquote\n*CmdOrCtrl+B* | toggleBold\n*CmdOrCtrl+H* | toggleHeadingSmaller\n*CmdOrCtrl+I* | toggleItalic\n*CmdOrCtrl+K* | drawLink\n*CmdOrCtrl+L* | toggleUnorderedList\n*CmdOrCtrl+P* | togglePreview\n*CmdOrCtrl+Alt+C* | toggleCodeBlock\n*CmdOrCtrl+Alt+I* | drawImage\n*CmdOrCtrl+Alt+L* | toggleOrderedList\n*Shift+CmdOrCtrl+H* | toggleHeadingBigger\n\n\u003cbr\u003e\n\n\\*I did say it was frank...\n\n# Releases\n\nYou can find 64-bit ready-to-use .dmg (macOS), .deb (Linux) and .exe/nsis (Windows) files here: [https://github.com/jjcosgrove/frank/releases](https://github.com/jjcosgrove/frank/releases)\n\n# Building from source\n\n## Requirements\n\n* [Node/NPM](https://nodejs.org/en/download/current/)\n* [Electron](https://electron.atom.io/)\n* [electron-builder](https://github.com/electron-userland/electron-builder)*\n\n\\* Only required if you wish to package the source code into an 'app' yourself using this repo's source files.\n\n## Installing build tools\n\n### Node/NPM\n\nYou can find the install binaries for your platform via the link above. This will install Node/NPM (the package manager for Node) and is available for most common platforms and CPU architectures.\n\n### Electron\n\n```\nnpm install -g electron\n```\n\nI.e. install Electron/electron globally, for easier usage. If you want more information and/or control over which variation of Electron gets installed, see: [https://www.npmjs.com/package/electron](https://www.npmjs.com/package/electron)\n\n## Building\n\nAssuming you have created a local folder called 'frank' and have entered into it from a shell/command line:\n\n### 1. Clone\n\n```\ngit clone https://github.com/jjcosgrove/frank.git .\n```\n\n### 2. Install\n\n```\nnpm install\n```\n\n### 3. Run\n\n```\nnpm start\n```\n\n# Packaging\n\nShould you wish to build your own binary/app, check out the package.json for the dist* scripts as a starting point; along with the build entry further down. You should already have electron-builder installed, via:\n\n```\nnpm install -g electron-builder\n```\n\nTo simply build a package, use the corresponding entry for the desired platform:\n\n## macOS\n\n```\nnpm run dist-mac\n```\n\n## Linux\n\n```\nnpm run dist-linux\n```\n\n## Windows\n\n```\nnpm run dist-win\n```\n\n## All\n\n```\nnpm run dist-all\n```\n\nIf you want to customise the build process, then type:\n\n```\nbuild --help\n```\n\nAnd you should get some more information. Alternatively, check out the electron-builder repo.\n\n**NOTE** Depending on your host OS, there may be further requirements when building for another platform/architecture. The electron-builder repo pages have further information, for e.g: [Multi-Platform-Build](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build)\n\n# Contribute\n\nBugs or feature requests/contributions can be done via:\n[https://github.com/jjcosgrove/frank/issues](https://github.com/jjcosgrove/frank/issues)\n\n# Authors\n\n* Just me for now\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjjcosgrove%2Ffrank","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjjcosgrove%2Ffrank","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjjcosgrove%2Ffrank/lists"}