Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rosano/hyperdraft
Turn your notes into a website.
https://github.com/rosano/hyperdraft
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
Last synced: 3 months ago
JSON representation
Turn your notes into a website.
- Host: GitHub
- URL: https://github.com/rosano/hyperdraft
- Owner: rosano
- License: other
- Created: 2019-12-26T16:51:36.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-07T20:18:50.000Z (10 months ago)
- Last Synced: 2024-10-29T20:23:57.579Z (3 months ago)
- 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
- Language: JavaScript
- Homepage: https://hyperdraft.rosano.ca
- Size: 2.17 MB
- Stars: 98
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Hyperdraft](https://hyperdraft.rosano.ca)
_Turn your text notes into a website_
Hyperdraft 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 guide for more details.
## Architecture
The 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.
Routing, rendering markdown content, and serving pages is done via a Node.js server (usually configured in the *controller.js* files).
## Development Setup
(For a deeper dive, watch [the tutorial](https://rosano.hmm.garden/01f62t5yseb053m024v1mczbzy)).
Install [Node.js and npm](https://nodejs.org/en/download/), then:
```
npm run setup
```
This 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`.
## Running
### Start the Rollup process to build and reload automatically
```
npm run watch
```
### Start the Node.js server to view in the browser
```
npm start
```
It should be accessible at http://localhost:3000.
## Testing
See [Testing logic and interfaces](https://rosano.hmm.garden/01f7v3hk3txz5d0v9ms467x8bz) for a tutorial.
### Run logic tests
```
npm test
```
### Run interface tests
```
npm test ui
```
To filter interface test paths by string:
```
npm test ui match=write
```
To filter interface test paths by JavaScript regular expressions:
```
npm test ui match='/(detail|vitrine)/'
```
## ❤️
Help me keep creating projects that are public, accessible for free, and open-source.
## License
The 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.
## Questions
Feel free to reach out on [Mastodon](https://rosano.ca/mastodon) or [Twitter](https://rosano.ca/twitter).