https://github.com/scrybbling-together/scrybble-site
The front and back-end of scrybble.ink
https://github.com/scrybbling-together/scrybble-site
obsidian obsidian-md obsidian-plugin remarkable remarkable-tablet
Last synced: about 1 year ago
JSON representation
The front and back-end of scrybble.ink
- Host: GitHub
- URL: https://github.com/scrybbling-together/scrybble-site
- Owner: Scrybbling-together
- Created: 2023-10-21T12:44:14.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T15:12:51.000Z (about 1 year ago)
- Last Synced: 2025-04-04T11:52:27.294Z (about 1 year ago)
- Topics: obsidian, obsidian-md, obsidian-plugin, remarkable, remarkable-tablet
- Language: JavaScript
- Homepage:
- Size: 87.8 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Scrybble
This is the back-end and front-end for [Scrybble](https://scrybble.ink). It's relatively easy to set-up locally, but does require some technical knowledge.
## Pre-requisites
1. Nix or NixOS, [installer](https://determinate.systems/posts/determinate-nix-installer/)
2. Docker
That's it.
## Set-up local dev environment
Run the following command in your shell
```bash
$ nix develop
# If it is your first time installing
# just press "yes" to the prompt command
# and everything will be set-up for you.
# run the frontend dev server when installation is finished
$ bun run dev
```
After running the last step, the site will be accessible on your [localhost](http://localhost)
## RMapi
We use https://github.com/ddvk/rmapi as a direct dependency for this project. This is used to authenticate and sync
with the ReMarkable API.
You can build the binary with
```bash
$ nix build .#rmapi
```
## Remarks
Remarks is the library we use to stitch together pdfs and .rm files. It's what turns a downloaded zip from the RMapi
into an annotated pdf, or a bunch of markdown.
I host a dockerfile at hub.docker.com, tagged `laauurraaa/remarks-bin:latest`.
`docker run -v "$PWD/YOUR FOLDER WITH REMARKABLE STUFF/":/store laauurraaa/remarks-bin:0.2.1 /store/in/YOUR_NOTEBOOK /store/out`
This command runs remarks over a test file, if you have any.
See the file `remarks.version` in the root directory for the most recent remarks version.