Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup package.json #8

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions APP_PROPS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# AppProps Overview

The following AppProps can be passed to the application:

```json
"appProps": {
"theme": {
"value": "theme-dark",
"type": "optional",
"description": "Override the default theme. Possible values are theme-light or theme-dark (default)"
},
"endpoint": {
"value": "",
"type": "required",
"description": "Base URL of the Limes API as stored in the Keystone catalog"
},
"projectID": {
"value": "",
"type": "required",
"description": "Project ID (if scoped to a project)"
},
"domainID": {
"value": "",
"type": "required",
"description": "Domain ID (if scoped to a project or domain)"
},
"token": {
"value": "",
"type": "required",
"description": "Keystone token for the scope specified by domain_id and project_id"
},
"canEdit": {
"value": false,
"type": "required",
"description": "Whether the user has edit permissions in the token's scope"
},
"embedded": {
"value": false,
"type": "optional",
"description": "Set to true if app is to be embedded in another existing app or page, like e.g. Elektra. If set to true the app won't render a page header/footer and instead render only the content. The default value is false."
},
"mockAPI": {
"value": false,
"type": "optional",
"description": "Wheter the API data should be mocked."
},
"local": {
"value": false,
"type": "optional",
"description": "Used to display debug log data in local development."
},
"quotaProject": {
"value": "",
"type": "optional",
"description": "Identify the current project."
},
"quotaAlign": {
"value": "",
"type": "optional",
"description": "Align the displayed quota text to start, center or end (default: end)"
}
},
```
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ npm install
}
```

A more detailed description about available properties can be found in the [AppProps](./APP_PROPS.md) documentation.

If the `mockAPI` attribute is set to `true` the endpint attribute becomes optional.

3. Run the app:
Expand Down
62 changes: 1 addition & 61 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@sapcc/limes-ui",
"version": "1.3.3",
"author": "VoigtS",
"license": "MIT",
"license": "Apache-2.0",
"source": "src/index.js",
"module": "build/index.js",
"private": false,
Expand Down Expand Up @@ -55,66 +55,6 @@
"lint": "npx eslint",
"test": "jest"
},
"importmapExtras": {
"zustand/middleware": "4.3.7"
},
"appProps": {
"theme": {
"value": "theme-dark",
"type": "optional",
"description": "Override the default theme. Possible values are theme-light or theme-dark (default)"
},
"endpoint": {
"value": "",
"type": "required",
"description": "Base URL of the Limes API as stored in the Keystone catalog"
},
"projectID": {
"value": "",
"type": "required",
"description": "Project ID (if scoped to a project)"
},
"domainID": {
"value": "",
"type": "required",
"description": "Domain ID (if scoped to a project or domain)"
},
"token": {
"value": "",
"type": "required",
"description": "Keystone token for the scope specified by domain_id and project_id"
},
"canEdit": {
"value": "false",
"type": "required",
"description": "Whether the user has edit permissions in the token's scope"
},
"embedded": {
"value": "false",
"type": "optional",
"description": "Set to true if app is to be embedded in another existing app or page, like e.g. Elektra. If set to true the app won't render a page header/footer and instead render only the content. The default value is false."
},
"mockAPI": {
"value": "false",
"type": "optional",
"description": "Wheter the API data should be mocked."
},
"local": {
"value": false,
"type": "optional",
"description": "Used to display debug log data in local development."
},
"quotaProject": {
"value": "string",
"type": "optional",
"description": "Identify the current project."
},
"quotaAlign": {
"value": "",
"type": "optional",
"description": "Align the displayed quota text to start, center or end (default: end)"
}
},
"dependencies": {
"@cloudoperators/juno-ui-components": "2.22.1",
"@cloudoperators/juno-url-state-provider": "*",
Expand Down
Loading