@inriver/inri 1.18.0 → 1.19.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/.changeset/chilly-boxes-count.md +5 -0
- package/CHANGELOG.md +7 -0
- package/README.md +41 -6
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -10,22 +10,56 @@ Before installing and using *inri*, please make sure you have the following peer
|
|
|
10
10
|
* vue version 3.x.x or any compatible version starting with 3
|
|
11
11
|
* vue-i18n version 9.1.7 or any compatible version starting with 9.1
|
|
12
12
|
* vue-router version 4.0.12 or any compatible version starting with 4
|
|
13
|
-
* WindiCSS - Follow this guide how to set it up https://windicss.org/
|
|
13
|
+
* WindiCSS - Follow this guide how to set it up https://windicss.org/guide/installation.html
|
|
14
14
|
|
|
15
15
|
## Installation
|
|
16
16
|
|
|
17
|
+
* Create a `.npmrc` file and add the following line `//registry.npmjs.org/:_authToken=${NPM_TOKEN}`
|
|
18
|
+
|
|
19
|
+
* Create `.env` file that is `.gitignored` (important!)
|
|
20
|
+
|
|
21
|
+
* Get the token from the `inri-access-group` variable group located in the pipelines
|
|
22
|
+
|
|
23
|
+
|
|
17
24
|
```
|
|
18
25
|
pnpm install @inriver/inri
|
|
19
26
|
pnpm install quasar@2.12.1 vue@^3.3.4 vue-i18n@^9.1.7 vue-router@^4.0.12
|
|
20
27
|
```
|
|
21
28
|
|
|
22
|
-
##
|
|
29
|
+
## Deploying your app with the inri framework
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
The build stage must also have access to the `inri-access-group`
|
|
33
|
+
Add it to your stage for example
|
|
34
|
+
```
|
|
35
|
+
stages:
|
|
36
|
+
- stage: Build
|
|
37
|
+
dependsOn:
|
|
38
|
+
variables:
|
|
39
|
+
- template: 'someTemplate.yml'
|
|
40
|
+
- group: inri-access-token
|
|
41
|
+
jobs:
|
|
42
|
+
...
|
|
43
|
+
```
|
|
44
|
+
Your build pipeline must have access to the .npmrc file so add this script
|
|
45
|
+
to the build stage of your pipeline.
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
- bash: |
|
|
49
|
+
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
|
|
50
|
+
env:
|
|
51
|
+
NPM_TOKEN: $(NPM_TOKEN)
|
|
52
|
+
displayName: Init .npmrc file
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Initializing the framework
|
|
23
56
|
|
|
24
57
|
main.ts (entry file)
|
|
58
|
+
It's importing that you import the `virtual:windi.css` after the App import
|
|
25
59
|
```
|
|
26
|
-
import 'virtual:windi.css';
|
|
27
60
|
import { createApp } from 'vue';
|
|
28
61
|
import App from './App.vue';
|
|
62
|
+
import 'virtual:windi.css';
|
|
29
63
|
|
|
30
64
|
import { initInriFramework } from '@inriver/inri';
|
|
31
65
|
const app = createApp(App);
|
|
@@ -46,18 +80,19 @@ CSS
|
|
|
46
80
|
Create a tailwind.config.js file and copy this
|
|
47
81
|
|
|
48
82
|
```
|
|
49
|
-
import
|
|
83
|
+
import { baseTailwindConfig } from './node_modules/@inriver/inri/configs/base-tailwind-config'
|
|
50
84
|
|
|
51
85
|
export default {
|
|
52
|
-
...
|
|
86
|
+
...baseTailwindConfig,
|
|
53
87
|
extract: {
|
|
54
88
|
include: [
|
|
55
|
-
'
|
|
89
|
+
'./node_modules/@inriver/inri/src/**/*.{vue,html,jsx,tsx}',
|
|
56
90
|
'src/**/*.{vue,html,jsx,tsx}',
|
|
57
91
|
],
|
|
58
92
|
},
|
|
59
93
|
}
|
|
60
94
|
|
|
95
|
+
|
|
61
96
|
```
|
|
62
97
|
### Using changesets
|
|
63
98
|
|