Skip to content

Commit d018e09

Browse files
committed
create readme for compliance hub
1 parent 29f79c9 commit d018e09

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

plugins/compliance-hub/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Compliance Hub plugin
2+
3+
## File structure
4+
File structure follows usual Countly plugin structure
5+
```
6+
compliance-hub/
7+
├── api/
8+
│ └── api.js # compliance hub API for managing user consent and related metrics
9+
├── frontend/
10+
│ ├── public
11+
│ │ ├── javascripts
12+
│ │ │ ├── countly.models.js # model code for consent management
13+
│ │ │ └── countly.views.js # views code.
14+
│ │ ├── localization # all localization files
15+
│ │ ├── stylesheets
16+
│ │ └── templates
17+
│ │ ├── consentHistory.html # template for consent history table
18+
│ │ ├── exportHistory.html # template for export history
19+
│ │ ├── main.html # compliance hub header
20+
│ │ ├── metrics.html # consent metrics dashboard
21+
│ │ ├── user.html # user consent data table
22+
│ │ └── userConsentHistory.html # user consent history table
23+
│ └── app.js
24+
├── install.js
25+
├── package.json
26+
├── README.md
27+
└── tests.js # plugin tests
28+
```

0 commit comments

Comments
 (0)