1
0
Fork 0
mirror of https://github.com/heyarne/airsonic-ui.git synced 2026-05-06 18:33:38 +02:00

Improve docs and simplify dev script

This commit is contained in:
Arne Schlüter 2018-08-22 09:40:14 +02:00
commit 6d9951b3f3
3 changed files with 12 additions and 2 deletions

View file

@ -27,7 +27,17 @@ $ npm install
$ npm run dev $ npm run dev
``` ```
**Note:** In dev mode this project comes with re-frame-10x. You can hit `Ctrl + h` to display the overlay and have a time traveling debugger. ### Editor integration
Integrating shadow-cljs with your editor helps tremendously with development. After having run `npm run dev` as described above you can connect to the REPL and get features like in-editor code execution and code completion / documentation lookup. For further information see [this part of the shadow-cljs user guide](https://shadow-cljs.github.io/docs/UsersGuide.html#_editor_integration), which contains instructions for Emacs, Atom, VSCode and other editors. Make sure to open `localhost:8080` in the browser to execute ClojureScript code.
### re-frame-10x
re-frame-10x is a debugger that is bundled with the app in development mode. Once you have the build running, hit `Ctrl + h` and the re-frame-10x window will show up:
![re-frame-10x in action](./docs/re-frame-10x.png)
It provides you with tools to inspect the state of the application, undo and replay events, debug performance issues and more.
## Tests ## Tests

BIN
docs/re-frame-10x.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

View file

@ -13,7 +13,7 @@
"dev:cljs": "shadow-cljs watch app test", "dev:cljs": "shadow-cljs watch app test",
"dev:sass": "npm run build:sass; node-sass -w src/sass/app.sass public/app/style.css", "dev:sass": "npm run build:sass; node-sass -w src/sass/app.sass public/app/style.css",
"dev:test": "karma start --reporters growl,progress --auto-watch", "dev:test": "karma start --reporters growl,progress --auto-watch",
"dev": "npm-run-all copy:* test:compile -p dev:*", "dev": "npm-run-all copy:* -p dev:*",
"test": "run-s test:compile test:run", "test": "run-s test:compile test:run",
"test:compile": "shadow-cljs compile test", "test:compile": "shadow-cljs compile test",
"test:run": "karma start --single-run" "test:run": "karma start --single-run"