An open API service indexing awesome lists of open source software.

https://github.com/schollz/offlinenotepad

An offline-first, secure, private notepad. :notebook_with_decorative_cover: :pencil2:
https://github.com/schollz/offlinenotepad

golang notepad notes notes-app offline-first pwa vue

Last synced: about 2 months ago
JSON representation

An offline-first, secure, private notepad. :notebook_with_decorative_cover: :pencil2:

Awesome Lists containing this project

README

        


offlinenotepad

https://offlinenotepad.com

*offlinenotepad* is an [open-source](https://github.com/schollz/offlinenotepad) offline note taking app. It is a browser-based offline-first notepad that securely syncs across your devices - including smartphones, laptops, and chromebooks. Ideally, its a minimalist note-writing experience that can be accessed anywhere, anytime.

**Offline-first.** All information is stored as encrypted data in the browser. Saving, editing, viewing, and searching are all done on the client.

**Secure.** offlinenotepad uses AES with the PBE algorithm (PBKDF2) with the [crypto-js library](https://github.com/brix/crypto-js) to encrypt data on the client and the server.

**Minimal.** This offline notepad aims to do as much as possible with as little as possible.

**Publish.** Any page can be "published" so that is accessible by anyone with a simple random link, like [`offlinenotepad.com/50e5791a`](https://offlinenotepad.com/50e5791a). The raw data can easily be easily cURLed by adding `/raw` to the end, e.g. [`offlinenotepad.com/50e5791a/raw`](https://offlinenotepad.com/50e5791a/raw).

**Code.** If the title of any document contains a period (".") then it will force the editor to be monospace and it will show the plain text in the viewer instead of transformed Markdown to HTML.

This writing tool is largely based of its predecessors: [cowyo](https://cowyo.com) and [rwtxt.com](https://rwtxt.com) (both also available on Github).

## Install

To run your own server for backing up notes you can simply install with Go.

```
$ git clone https://github.com/schollz/offlinenotepad
$ cd offlinenotepad
$ go generate -v -x
$ go build -v
```

And then you can run

```

$ ./offlinenotepad
```

Log into `localhost:8251` to see the site.

### Docker

Alternatively you can run with docker:

```
$ docker run -v /location/to/save/data:/data -p 8251:8251 schollz/offlinenotepad
```

## Acknowledgements

I took a lot of help from @GoogleChromeLabs with their [airhorn](https://github.com/GoogleChromeLabs/airhorn).

## License

MIT