orgnote-client
orgnote-client copied to clipboard
Frontend side for second brain service
:PROPERTIES: :ID: orgnote-client :END:
#+html:
#+html: #+TITLE: ✨ Org Note client. #+html:
#+html: #+html:-
Introduction #+html:
#+html:#+html: This project is part of [[https://github.com/Artawower/orgnote][Org Note project]]. This is client side based on the [[https://quasar.dev/][Quasar]] framework. It's include ios/android/pwa and desktop build. It's a proof of concept solution, in the future I have plan to migrate this repo into native app or Flutter.
#+html: -
Connected links
- [[https://github.com/Artawower/orgnote][Main repo]]
- [[https://github.com/Artawower/orgnote/wiki][WIKI]]
- [[https://github.com/Artawower/orgnote-backend][Org Note backend]]
- [[https://github.com/Artawower/orgnote-extensions][List of extensions and themes]]
- [[https://github.com/Artawower/orgnote-api][Create your own plugin!]]
- [[https://en.wikipedia.org/wiki/Zettelkasten][About Zettelkasten approach]]
- [[https://quasar.dev/][Quasar]]
- [[./VARIABLES.org][List of all css variables for theme tooling]]
- Install ** Local development Clone repo #+BEGIN_SRC bash git clone [email protected]:Artawower/orgnote-client.git && cd secon-brain-client #+END_SRC
Install dependencies (as alternative you can use ~npm~) #+BEGIN_SRC bash bun install #+END_SRC
Start development #+BEGIN_SRC bash :tangle file bun run dev #+END_SRC ** Environment variables ~API_URL~ - url to api server
- 🍩 Contribute guide
Any contribution is very much appreciated! Please read the [[https://github.com/Artawower/orgnote/wiki/Contribution-guide][style guide]] before contributing to avoid misunderstandings! I would also appreciate it if you would consider becoming my [[https://www.patreon.com/artawower][patron]]
** Debug PWA #+BEGIN_SRC bash npm run build:pwa && docker compose -f docker-compose.pwa.yaml up #+END_SRC