{"id":16975529,"url":"https://github.com/shu8/quickjots","last_synced_at":"2025-04-12T01:17:10.317Z","repository":{"id":39379823,"uuid":"209366542","full_name":"shu8/quickjots","owner":"shu8","description":"A web-app to jot down and auto-save any quick notes, all in your browser! Use Markdown or plain-text, no registration needed, dark mode available!","archived":false,"fork":false,"pushed_at":"2022-12-14T22:37:36.000Z","size":1156,"stargazers_count":7,"open_issues_count":16,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T01:17:05.235Z","etag":null,"topics":["browser-app","dark-mode","markdown","no-registration","notes","notes-tool","offline-capable","quickjots","web-app","website"],"latest_commit_sha":null,"homepage":"https://quickjots.app","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/shu8.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}},"created_at":"2019-09-18T17:28:13.000Z","updated_at":"2023-09-08T17:58:07.000Z","dependencies_parsed_at":"2022-08-25T17:12:50.199Z","dependency_job_id":null,"html_url":"https://github.com/shu8/quickjots","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shu8%2Fquickjots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shu8%2Fquickjots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shu8%2Fquickjots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shu8%2Fquickjots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shu8","download_url":"https://codeload.github.com/shu8/quickjots/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501858,"owners_count":21114684,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["browser-app","dark-mode","markdown","no-registration","notes","notes-tool","offline-capable","quickjots","web-app","website"],"created_at":"2024-10-14T01:23:03.027Z","updated_at":"2025-04-12T01:17:10.291Z","avatar_url":"https://github.com/shu8.png","language":"JavaScript","readme":"# QuickJots\n\nQuickJots is a web-app to jot down and auto-save any quick notes in your browser, using Markdown or plain-text. No registration is needed, and there is a dark mode available!\n\nBoth plain-text and markdown notes are supported (with the help of [Showdown](https://github.com/showdownjs/showdown)).\n\nThis repository contains all the source code for the web-app at [quickjots.app](https://quickjots.app).\n\nQuickJots is currently hosted using [Netlify](http://netlify.com), so there is also a `netlify.toml` file in the root to configure Netlify.\n\n## Getting Started\n\nIf you want to contribute to QuickJots, or host it yourself, you'll need to fork this repo through GitHub, followed by:\n\nQuickJots uses [Webpack](https://webpack.js.org/) bundles the source code in this repo together into a static site. It uses a Service Worker to provide offline support.\n\nThe main Javascript code is in [`./src/js`](./src/js) -- the files all use the base `window.quickjots` object and add any needed functions and variables to this.\n\n1. `git clone git@github.com:[username]/quickjots.git`\n2. Ensure you have [Node.JS](https://nodejs.org/en/) installed (to bundle the files with Webpack)\n3. Run `yarn install` in the root repo directory to install the dependencies\n4. Run `yarn start` to run the webpack dev server on your local port `8080` whilst modifying the code. It will auto-reload on any change\n5. Run `yarn build` to run webpack in production mode to generate files in `dist/`. These files contain the static site, for you to host yourself if you want\n\nNote you might want to disable the Service Worker in dev-mode if you are testing many changes locally, otherwise you'll see old code working instead of your new code! There's also a 'update on reload' option in Chrome Dev Tools for Service Workers if you don't want to disable it for dev-mode.\n\n## Contributing\n\nAny contributions like bug reports, feature requests or pull requests are welcome!\n\nThere is an ESLint config in [`.eslintrc.json`](./.eslintrc.json), but in short the main code-style is:\n\n- use 2-space indentation\n- use spaces for indentation\n- use semicolons at the end of statements\n- use arrow functions where possible\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshu8%2Fquickjots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshu8%2Fquickjots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshu8%2Fquickjots/lists"}