azion-theme 1.4.0 → 1.4.2

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/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ ## [1.4.2](https://github.com/aziontech/azion-theme/compare/v1.4.1...v1.4.2) (2024-08-01)
2
+
3
+ ### Bug Fixes
4
+
5
+ * text typo ([a1c28aa](https://github.com/aziontech/azion-theme/commit/a1c28aa79d11aad4bce50fdfacb2b70ac3880680))
6
+
7
+ ## [1.4.1](https://github.com/aziontech/azion-theme/compare/v1.4.0...v1.4.1) (2024-08-01)
8
+
9
+ ### Bug Fixes
10
+
11
+ * documentation ([16b7e1c](https://github.com/aziontech/azion-theme/commit/16b7e1cba8031233ac6ada163e8f1d9b5944edd0))
12
+
1
13
  ## [1.4.0](https://github.com/aziontech/azion-theme/compare/v1.3.5...v1.4.0) (2024-07-31)
2
14
 
3
15
  ### Features
package/README.md CHANGED
@@ -1,77 +1,77 @@
1
- <h1 align="center">
2
- azion-theme
3
- </h1>
1
+ # azion-theme
4
2
 
5
- <p align="center">
6
- <img src="./doc/cover.png" alt="Sass Cover Azion Theme"/>
7
- </p>
3
+ ![Sass Cover Azion Theme](./doc/cover-image.png)
8
4
 
9
- <p align="center">
10
- The Azion Theme repositorie is focused to share our style kit between interfaces and be used in all projeects inside the company,
11
- Real Time Manager, Azion Web Site, Landing Pages and all the user iteraction with Azion.
12
- </p>
5
+ The Azion Theme repository is focused on sharing our style kit across interfaces and should be used in all company projects,
6
+ including Azion Console Kit, Azion Site, Landing Pages, and all user interactions with Azion.
13
7
 
14
- ## How to use
15
8
 
16
- To be able to download and publish Azion Github Packages It is necessary a basic Auth autentication.
9
+ ## Easy to install
17
10
 
18
- On your file `~/.npmrc` you need the below configuration:
11
+ To install the azion-theme project, you need to follow the command.
12
+ Choice one of your preference: npm or yarn;
19
13
 
20
14
  ``` bash
21
- //registry=https://npm.pkg.github/aziontech=true
22
- //npm.pkg.github.com/:_authToken=ghp_SprUskNOYknOQWEDJ02qFX1gB5zeaEd3GTIrs
23
- @aziontech:registry=https://npm.pkg.github.com/
15
+ npm install azion-theme --save
16
+ # or
17
+ yarn add azion-theme
24
18
  ```
25
19
 
26
- > Don't forget to replace the `_authToken` value param. The currently value is a g.e;
20
+ Alternatively, you can configure the package.json file by adding the dependency:
27
21
 
22
+ ``` json
23
+ {
24
+ "dependencies": {
25
+ "azion-theme": "ˆ1.4.0"
26
+ }
27
+ }
28
+ ```
28
29
 
29
- ## How to install
30
+ After updating the package.json file, run npm install in the root of your project to install the Azion Theme.
30
31
 
31
- With the configured autentication you need to:
32
32
 
33
- ``` bash
34
- npm install @aziontech/azion-theme;
35
- ```
33
+ ### Easy to connect with Front-End Project
36
34
 
37
- or configure the `package.json` file increasing the dependencie packages;
35
+ To integrate the Azion Theme into your front-end project,
36
+ you need to import the theme files in your project's entry point file (App.vue, main.js, index.js, etc.):
38
37
 
39
- ``` json
40
- {
41
- "dependencies": {
42
- "@aziontech/azion-theme": "ˆ0.0.2"
43
- }
44
- }
38
+ ``` javascript
39
+ import 'azion-theme/dark';
40
+ import 'azion-theme/light';
45
41
  ```
46
42
 
47
- and you will be able to run `npm install` inside the root of project.
43
+ Make sure to include these imports at the top of your entry point file
44
+ to ensure the styles are applied correctly throughout your application.
48
45
 
49
46
 
50
- ## How to work to develop
47
+ ## How to locally development
51
48
 
52
- To local maintaining you should clone the the `azion-theme` repository and the another one where `azion-theme` will be used;
49
+ To work locally, you should clone both the `azion-theme`
50
+ repository and the another repository where theme will be used.
53
51
 
54
52
  ### Example:
55
- In this example we will use an [azion-web-kit](https://github.com/aziontech/azion-web-kit) example:
53
+ In this example, we will use the [azion-webkit](https://github.com/aziontech/azion-webkit) repository:
56
54
 
55
+ 1. Clone the `azion-webkit` and `azion-theme` repositories;
56
+ ```bash
57
+ git clone https://github.com/aziontech/azion-webkit.git
58
+ git clone https://github.com/aziontech/azion-theme.git
59
+ ```
57
60
 
58
- ``` bash
59
- git clone git@github.com:aziontech/azion-web-kit.git
60
- git clone git@github.com:aziontech/azion-theme.git
61
+ 2. Installing dependecies and create the link point;
62
+ ```bash
63
+ cd ./azion-theme && npm i && npm link
64
+ ```
61
65
 
62
- cd azion-theme && npm install -g
63
- cd ../azion-web-kit && npm install && npm link @aziontech/azion-theme
66
+ 3. Linking the `azion-theme` to the `azion-webkit` project;
67
+ ```bash
68
+ cd ../azion-webkit && npm i && npm link azion-theme
69
+ ```
64
70
 
65
- npm run dev; # any azion-theme modification will be reflected on this dev server with hot reload
66
- ```
71
+ Any modifications made to `azion-theme` will be reflected on this development server with hot reload.
67
72
 
68
- ### How to integrate in the Front-End Projec/?
69
73
 
70
- On your `App.vue, main.js, index.js` or any anoter project entrypoint you need to import the both files:
71
-
72
- ``` javascript
73
- import '../node_modules/@aziontech/azion-theme/src/azion-light/theme.scss';
74
- import '../node_modules/@aziontech/azion-theme/src/azion-dark/theme.scss';
75
- ```
74
+ ## Links
76
75
 
77
- > Will can import in your main.scss
76
+ - https://v3.primevue.org/
77
+ - https://github.com/primefaces/primevue-sass-theme
Binary file
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "azion-theme",
3
3
  "type": "module",
4
- "version": "1.4.0",
4
+ "version": "1.4.2",
5
5
  "author": "aziontech",
6
6
  "contributors": [
7
7
  {
package/doc/cover.png DELETED
Binary file