Skip to content

Commit fe7ba2c

Browse files
authored
Update README.md
1 parent e443eb0 commit fe7ba2c

File tree

1 file changed

+3
-31
lines changed

1 file changed

+3
-31
lines changed

README.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,7 @@
11
# OS2IoTFrontend
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.9.
3+
Build Status
44

5-
## Development server
5+
Documentation is available at: https://os2iot.readthedocs.io/en/latest/
66

7-
Run from docker or 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.
8-
9-
## Code scaffolding
10-
11-
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`.
12-
13-
## Build
14-
15-
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.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24-
25-
## Further help
26-
27-
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).
28-
29-
## More
30-
31-
The code structure: Inside src the assets folder contains general scss files and other assets such as images, fonts and language files. In the App folder there are three folders that contain the code files:
32-
33-
models: contains interfaces/models
34-
shared: contains all the modules and components that are used by several views - used more places than one
35-
views: the "landingpages" of the different nav menu items. Here are the specific modules and components only used this one place as opposed to those in shared
7+
Start using docker-compose see: https://github.com/OS2iot/OS2IoT-docker

0 commit comments

Comments
 (0)