1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# DataLake Admin UI
DataLake Admin UI aims to provide the administrator with a user-friendly dashboard to easily monitor and manage ONAP topics, database, and tools via REST API from DataLake Feeder backend system.
See more [DataLake Proposal on ONAP](https://wiki.onap.org/display/DW/DataLake "DataLake Proposal on ONAP")
### Getting Started
1. Go to project folder and install dependencies:
```bash
npm install
```
2. Launch development server, and open `localhost:4200` in your browser:
```bash
npm start
```
### Project Structure
```
-- app
-- shared -----> container of pubilc parts
-- components -----> container of pubilc components
-- alert
-- toastr-notification
-- ...more components
-- modules -----> container of public business modules
-- card
-- modal
-- search
-- table
-- layout -----> container of basic layout of all pages
-- header
-- sidebar
-- utils -----> container of general functions
-- core -----> container of core functions
-- models
-- services
-- views -----> container of all business pages
-- about
-- dashboard-setting
-- database
-- feeder
-- topics
-- ...more modules
-- mockup -----> mockup data for pages
-- app-routing.module.ts -----> container of all pages routers
-- app-component.css
-- app-component.html
-- app-component.ts
-- app-module.ts
-- assets
-- i18n
-- index.html
-- main.ts
-- styles.css
-- ...other config documents
```
> The layout is used for organizing a new module, **PLEASE** take care of the difference between `components` and `modules`. Make sure that all parts added in the `components` are `dump components` and all the parts which are related to the **business** should be added in the `modules`. Good luck 🙂.
> The service folder is used for created some reused services. **PLEASE** put the specific services into the related folders. For example, put the toastr-notification service into the `components/toastr-notification` folder.
### [Change log](./CHANGELOG.md)
### Git commit message rules
PLEASE obey [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#) when write the commit messages. One commit message should include three parts: `Header`, `Body` and `Footer`. The `Header` part is necessary, and the other two parts are optional. The `Header` part follows the rule as: `<type>(<scope>): <subject>`. `type` and `subject` are necessary, `scope` is optional. Only 7 tokens are allowed for `type`:
* feat: new features（feature）
* fix: fix bugs
* docs: documentation
* style: style
* refactor：reconstruction
* test：add test
* chore：change for construction and assistant tools
For example:
```bash
feat(directive): ng:disabled, ng:checked, ng:multiple, ng:readonly, ng:selected
-----------------------------------------------------
docs(guide): updated fixed docs from Google Docs
Couple of typos fixed:
- indentation
- batchLogbatchLog -> batchLog
- start periodic checking
- missing brace
```
When there is breaking changes in the project, please write the commit message in `Footer`. For example:
```bash
BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly useful for directives so there should be no code using it.
```
Also, run the script `npm run changelog` can generate all the `feat` and `fix` commits. Click [CHANGELOG.md](./CHANGELOG.md) shows all these commit histories.
|
