add docs and improve development setup
This commit is contained in:
parent
17e0e33218
commit
8bb3a3b8d7
3 changed files with 46 additions and 0 deletions
2
.dir-locals.el
Normal file
2
.dir-locals.el
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
((nil . ((cider-default-cljs-repl . shadow)
|
||||
(cider-shadow-default-options . "frontend"))))
|
||||
40
README.md
Normal file
40
README.md
Normal 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
|
||||
```
|
||||
|
||||
|
|
@ -8,5 +8,9 @@
|
|||
"dependencies": {
|
||||
"react": "npm:@preact/compat@^18.3.1",
|
||||
"react-dom": "npm:@preact/compat@^18.3.1"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "shadow-cljs release frontend",
|
||||
"dev": "shadow-cljs watch frontend"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue