https://github.com/dit7ya/roamex
Seamless integration between Emacs org-mode notetaking and highlights/annotations on the web
https://github.com/dit7ya/roamex
firefox firefox-extension hacktoberfest org-mode personal-knowledge-management
Last synced: 8 months ago
JSON representation
Seamless integration between Emacs org-mode notetaking and highlights/annotations on the web
- Host: GitHub
- URL: https://github.com/dit7ya/roamex
- Owner: dit7ya
- License: agpl-3.0
- Created: 2021-09-21T14:53:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-03T12:33:37.000Z (about 4 years ago)
- Last Synced: 2025-02-23T08:42:42.576Z (8 months ago)
- Topics: firefox, firefox-extension, hacktoberfest, org-mode, personal-knowledge-management
- Language: Svelte
- Homepage:
- Size: 213 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: readme.org
- License: LICENSE
Awesome Lists containing this project
README
#+TITLE: Roamex
Annotate and highlight on the web but store the data in org files, while seamlessly referencing org-roam nodes.
* WARNING
This is in a horribly WIP state, not at all ready for daily usage. Expect bugs, breaking changes, and low-quality code all around. You are still welcome to try it and provide feedback if you are super excited about the idea of finally being able to integrating org-modes and the browser.
* Installation
** Backend
#+begin_src sh
cd backend
poetry build
cd dist
pip install
roamex serve
#+end_src
** Frontend
Get the .xpi file from me and install in Firefox
* Usage
- Create a config file at ~~/.config/roamex/config.yaml~ which has the following three fields.
#+begin_src yaml
org_roam_directory : ""
org_roam_db_location : ""
roamex_db_location : ""
#+end_src
- Create a directory called ~roamex~ under your org roam directory.
- Open a webpage, select some text, follow the buttons.
* Developing
- clone repo locally
- follow first two steps of usage
- run the backend server
#+begin_src sh
cd backend
poetry run uvicorn src.api:app --reload
#+end_src
- start the fronend build script
#+begin_src sh
cd frontend
node buildscript.js
#+end_src
- start a firefox with the extension installed via web-ext
#+begin_src sh
cd frontend/dist
web-ext run -v
#+end_src