diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..aae787f3a --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (C) 2020 Kastelo AB + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +- The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 3697cc4c0..714709ffb 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,28 @@ -# TechUi - -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.5. +# Syncthing Tech UI ## Development server -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +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. ## Production server -Run `ng build --prod --base-href /tech-ui/` and build [syncthing tech-ui branch](https://github.com/kastelo/syncthing/tree/tech-ui). Run `export STNOUPGRADE=1 STTECHUIDIR=/path/to/angular/build/; ./bin/syncthing` and navigate to `http://localhost:8384/tech-ui/`. +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. + +- `npm run build -- --prod` +- `rsync -va --delete dist/tech-ui/ ~/.config/syncthing/gui/default/tech-ui/` + +Adjust for your actual Syncthing config dir if different. Navigate to +`http://localhost:8384/tech-ui/`. ## Code scaffolding -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`. +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`. -## Build +# License -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. - -## Running unit tests - -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). - -## Running end-to-end tests - -Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). - -## Further help - -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). +MIT