{"id":13676611,"url":"https://github.com/rosano/hyperdraft","last_synced_at":"2025-04-14T05:20:51.847Z","repository":{"id":46565915,"uuid":"230297548","full_name":"rosano/hyperdraft","owner":"rosano","description":"Turn your notes into a website.","archived":false,"fork":false,"pushed_at":"2024-04-07T20:18:50.000Z","size":2273,"stargazers_count":108,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T09:24:29.367Z","etag":null,"topics":["0data","digital-garden","local-first","memex","note-taking","notes-app","personal-site","personal-website","plaintext","remotestorage","second-brain","static-site","static-site-generator","static-website","unhosted","wiki","zettelkasten"],"latest_commit_sha":null,"homepage":"https://hyperdraft.rosano.ca","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rosano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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},"funding":{"open_collective":"rosano"}},"created_at":"2019-12-26T16:51:36.000Z","updated_at":"2025-03-27T12:17:42.000Z","dependencies_parsed_at":"2024-01-14T05:07:23.715Z","dependency_job_id":"f7552303-c646-4de9-b783-90a556babb01","html_url":"https://github.com/rosano/hyperdraft","commit_stats":{"total_commits":2771,"total_committers":4,"mean_commits":692.75,"dds":0.002887044388307447,"last_synced_commit":"b6da3c39788a0adb3b2b81f70e6fc813ff1c5b1f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosano%2Fhyperdraft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosano%2Fhyperdraft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosano%2Fhyperdraft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosano%2Fhyperdraft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rosano","download_url":"https://codeload.github.com/rosano/hyperdraft/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824993,"owners_count":21167412,"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":["0data","digital-garden","local-first","memex","note-taking","notes-app","personal-site","personal-website","plaintext","remotestorage","second-brain","static-site","static-site-generator","static-website","unhosted","wiki","zettelkasten"],"created_at":"2024-08-02T13:00:30.357Z","updated_at":"2025-04-14T05:20:51.820Z","avatar_url":"https://github.com/rosano.png","language":"JavaScript","readme":"\u003ca href=\"https://hyperdraft.rosano.ca\"\u003e\u003cimg alt=\"Project logo\" src=\"https://static.rosano.ca/wikiavec/identity.svg\" width=\"64\" /\u003e\u003c/a\u003e\n\n# [Hyperdraft](https://hyperdraft.rosano.ca)\n\n_Turn your text notes into a website_\n\n\u003ca href=\"https://hyperdraft.rosano.ca\"\u003eHyperdraft\u003c/a\u003e helps you organize your thinking with text notes, and makes it simple to turn them into a website. Inspired by modeless and keyboard-centric [Notational Velocity](http://notational.net/) it lets you quickly and easily network your ideas via a simple double-bracket syntax. Use it for ideas, todo lists, brainstorming, recipes, reading notes, journaling, or anything involving writing. Read the \u003ca href=\"https://hyperdraft.rosano.ca\"\u003eguide\u003c/a\u003e for more details.\n\n\u003ca href=\"https://hyperdraft.rosano.ca/write\"\u003e\u003cimg alt=\"Open app\" src=\"http://static.rosano.ca/_shared/_RCSAppButton.svg\" /\u003e\u003c/a\u003e\n\n## Architecture\n\nThe project follows a [Universal folder structure](https://rosano.hmm.garden/01f71kp52knc5nnv08qr9kzj3m) and is a large collection of mostly small modules or functions that are put together using [Svelte](https://svelte.dev) and [Rollup](https://rollupjs.org). With the exception of a few 'global' or 'magic' things such as the localization function `OLSKLocalized`, most resources used by a module should be in the same folder or referenced by path name.\n\nRouting, rendering markdown content, and serving pages is done via a Node.js server (usually configured in the *controller.js* files).\n\n## Development Setup\n\n(For a deeper dive, watch [the tutorial](https://rosano.hmm.garden/01f62t5yseb053m024v1mczbzy)).\n\nInstall [Node.js and npm](https://nodejs.org/en/download/), then:\n\n```\nnpm run setup\n```\n\nThis should create an `.env` file if there is none. If you encounter errors referring to this file, you can find missing variables in `.env-sample`.\n\n## Running\n\n### Start the Rollup process to build and reload automatically\n\n```\nnpm run watch\n```\n\n### Start the Node.js server to view in the browser\n\n```\nnpm start\n```\n\nIt should be accessible at \u003ca href=\"http://localhost:3000\" target=\"_blank\"\u003ehttp://localhost:3000\u003c/a\u003e.\n\n## Testing\n\nSee [Testing logic and interfaces](https://rosano.hmm.garden/01f7v3hk3txz5d0v9ms467x8bz) for a tutorial.\n\n### Run logic tests\n\n```\nnpm test\n```\n\n### Run interface tests\n\n```\nnpm test ui\n```\n\nTo filter interface test paths by string:\n\n```\nnpm test ui match=write\n```\n\nTo filter interface test paths by JavaScript regular expressions:\n\n```\nnpm test ui match='/(detail|vitrine)/'\n```\n\n## ❤️\n\nHelp me keep creating projects that are public, accessible for free, and open-source.\n\n\u003ca href=\"https://rosano.ca/back\"\u003e\u003cimg alt=\"Become a backer\" src=\"https://static.rosano.ca/_shared/_RCSBackButton.svg\" /\u003e\u003c/a\u003e\n\n## License\n\nThe code is released under a [Hippocratic License](https://firstdonoharm.dev), modified to exclude its use for surveillance capitalism and also to require large for-profit entities to purchase a paid license.\n\n## Questions\n\nFeel free to reach out on [Mastodon](https://rosano.ca/mastodon) or [Twitter](https://rosano.ca/twitter).\n","funding_links":["https://opencollective.com/rosano"],"categories":["JavaScript","wiki"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frosano%2Fhyperdraft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frosano%2Fhyperdraft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frosano%2Fhyperdraft/lists"}