add docs and improve development setup

This commit is contained in:
arne 2025-11-09 08:35:00 +01:00
commit 8bb3a3b8d7
3 changed files with 46 additions and 0 deletions

40
README.md Normal file
View file

@ -0,0 +1,40 @@
# Lodestone
Lodestone is an application to help you navigate the fediverse. It surfaces things you enjoyed by providing a private search interface that runs fully in your own browser.
## Building a release
Before anything, make sure JS dependencies are installed:
``` bash
npm install
```
After that
``` bash
npm run build
```
## Development
Just as when building a release, you need to ensure that JS dependencies are installed:
``` bash
npm install
```
After that you can start a process that watches and continuously builds and reloads your app when the source code is changed:
``` bash
npm run dev
```
I'd recommend setting up a better development environment and [integrating shadow-cljs deeply into your editor](https://shadow-cljs.github.io/docs/UsersGuide.html#_editor_integration). You can get a continuous build that hot-reloads your app like above, and a REPL that allows you to send and evaluate individual expressions from your editor. This allows you to inspect and modify state and trigger events as you are live-developing your application.
If you set up Emacs + [CIDER](https://docs.cider.mx/cider/config/basic_config.html) this can be done by running:
``` txt
M-x cider-jack-in-cljs
```