@data-fair/app-dashboards 0.0.1-staging.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +52 -0
- package/package.json +27 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 data-fair
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @data-fai/app-dashboards
|
|
2
|
+
|
|
3
|
+
A data-fair application for generic dashboards created by assembling other applications.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
Install the dependencies:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Development Server
|
|
14
|
+
|
|
15
|
+
Start the development server on `http://localhost:3000`
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm run dev
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Production
|
|
22
|
+
|
|
23
|
+
Build the application for production:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm run build
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Locally preview production build:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm run preview
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Deployment
|
|
36
|
+
|
|
37
|
+
Simply publish the project on the global npm registry (you need to be member of the owner organization).
|
|
38
|
+
|
|
39
|
+
npm version PATCH|MINOR|MAJOR
|
|
40
|
+
npm publish
|
|
41
|
+
git push && git push --tags
|
|
42
|
+
|
|
43
|
+
If the release is a bug fix and you don't want to wait 24h (the cache delay of jsdelivr), you can purge the cache for the index.html file of the minor version in the CDN:
|
|
44
|
+
|
|
45
|
+
curl https://purge.jsdelivr.net/npm/@data-fair/app-dashboards@0.8/dist/index.html
|
|
46
|
+
|
|
47
|
+
To publish a version for testing purposes you can tag it as a pre-release and publish it with the tag "staging".
|
|
48
|
+
|
|
49
|
+
npm version prerelease --preid=staging
|
|
50
|
+
npm publish --tag staging
|
|
51
|
+
curl https://purge.jsdelivr.net/npm/@data-fair/app-dashboards@staging/dist/index.html
|
|
52
|
+
git push && git push --tags
|
package/package.json
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@data-fair/app-dashboards",
|
|
3
|
+
"version": "0.0.1-staging.0",
|
|
4
|
+
"scripts": {
|
|
5
|
+
"dev": "DATAFAIR_URL=https://staging-koumoul.com/data-fair DATAFAIR_OWNER_ID=jxKDdH3lR df-dev-server",
|
|
6
|
+
"dev-src": "nuxt dev",
|
|
7
|
+
"prepublishOnly": "PUBLIC_URL=https://cdn.jsdelivr.net/npm/@data-fair/app-dashboards@${npm_package_version}/dist nuxt generate",
|
|
8
|
+
"lint": "eslint . --fix"
|
|
9
|
+
},
|
|
10
|
+
"files": [
|
|
11
|
+
"/dist",
|
|
12
|
+
"/README.md"
|
|
13
|
+
],
|
|
14
|
+
"devDependencies": {
|
|
15
|
+
"@data-fair/dev-server": "^1.11.0",
|
|
16
|
+
"@nuxtjs/eslint-config-typescript": "^12.0.0",
|
|
17
|
+
"@types/node": "^18",
|
|
18
|
+
"@typescript-eslint/eslint-plugin": "^5.59.8",
|
|
19
|
+
"debug": "^4.3.4",
|
|
20
|
+
"eslint": "^8.41.0",
|
|
21
|
+
"nuxt": "^3.5.2",
|
|
22
|
+
"vite-plugin-vuetify": "^1.0.2"
|
|
23
|
+
},
|
|
24
|
+
"dependencies": {
|
|
25
|
+
"@koumoul/v-iframe": "^2.0.0"
|
|
26
|
+
}
|
|
27
|
+
}
|