syncthing/README.md

48 lines
1.2 KiB
Markdown
Raw Normal View History

2020-03-31 06:54:40 -07:00
# Syncthing Tech UI
2020-03-10 07:57:02 -07:00
## Development server
2020-03-31 06:54:40 -07:00
Run `npm run serve` for a dev server. Navigate to `http://localhost:4200/`. The
app will automatically reload if you change any of the source files.
2020-03-15 09:33:21 -07:00
## Production server
2020-03-31 06:54:40 -07:00
In production we serve the UI through Syncthing itself. The easiest way to
do that is to simply put the built assets in the `gui` subdirectory of
Syncthing's config directory.
2020-03-10 07:57:02 -07:00
2020-03-31 07:14:09 -07:00
```
$ npm run build -- --prod
$ rsync -va --delete dist/tech-ui/ ~/.config/syncthing/gui/default/tech-ui/
```
2020-03-10 07:57:02 -07:00
2020-03-31 06:54:40 -07:00
Adjust for your actual Syncthing config dir if different. Navigate to
`http://localhost:8384/tech-ui/`.
2020-03-10 07:57:02 -07:00
2020-03-31 07:14:09 -07:00
Another option is to start Syncthing with the STGUIASSETS environment
variable pointing to the distribution directory.
```
$ npm run build -- --prod
$ ln -sf . dist/default
$ export STGUIASSETS=$(pwd)/dist
$ syncthing
```
The magic is symlink is because Syncthing will look for the GUI in the
`default` subdirectory. Navigate to `http://localhost:8384/tech-ui/`.
2020-03-31 06:54:40 -07:00
## Code scaffolding
2020-03-10 07:57:02 -07:00
2020-03-31 06:54:40 -07:00
Run `ng generate component component-name` to generate a new component. You
can also use `ng generate
directive|pipe|service|class|guard|interface|enum|module`.
2020-03-10 07:57:02 -07:00
## License
2020-03-10 07:57:02 -07:00
MPLv2
## Copyright
Copyright (c) 2020 Kastelo Inc.