@cincoders/cinnamon 0.1.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 +36 -0
- package/package.json +92 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 CIn-UFPE
|
|
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,36 @@
|
|
|
1
|
+
# Cinnamon
|
|
2
|
+
|
|
3
|
+
CInnamon is a powerful React package that offers a variety of components designed to simplify the development process and enhance the appearance of systems across multiple projects. With its reusable components, CInnamon allows for standardization of system design, making it the ideal tool for micro front-ends. Whether you're working on a small or large-scale project, CInnamon can streamline the development process and improve the overall user experience. Its versatility and flexibility make it an essential tool for any development team looking to optimize their workflow and produce high-quality applications.
|
|
4
|
+
|
|
5
|
+
## Technologies used
|
|
6
|
+
|
|
7
|
+
- [React](https://pt*br.reactjs.org/)
|
|
8
|
+
- [MUI](https://mui.com/)
|
|
9
|
+
- [Storybook](https://storybook.js.org/)
|
|
10
|
+
- [Rollup](https://rollupjs.org/guide/en/)
|
|
11
|
+
- [Keycloak](https://www.keycloak.org/)
|
|
12
|
+
|
|
13
|
+
## Installation in other projects
|
|
14
|
+
|
|
15
|
+
To install the Cinnamon package into your project use the [node package manager (npm)](https://nodejs.org/) and run the command:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @cincoders/cinnamon
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
For a extensive list of all components, interfaces and examples on how to use them refer to our [usage guide](.github/USAGE.MD).
|
|
24
|
+
|
|
25
|
+
## Access Management
|
|
26
|
+
|
|
27
|
+
[As stated before](#technologies-used) we use Keycloak to implement access management. You can use it as well or use your own solution.
|
|
28
|
+
|
|
29
|
+
## Contribution
|
|
30
|
+
|
|
31
|
+
Contributions are welcome!
|
|
32
|
+
To know a step by step guide on how to contribute refer to our [contribution guide](.github/CONTRIBUTING.md).
|
|
33
|
+
|
|
34
|
+
## License
|
|
35
|
+
|
|
36
|
+
[MIT](LICENSE)
|
package/package.json
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@cincoders/cinnamon",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Reusable React components",
|
|
5
|
+
"main": "dist/cinnamon.ssr.js",
|
|
6
|
+
"browser": "dist/cinnamon.esm.js",
|
|
7
|
+
"module": "dist/cinnamon.esm.js",
|
|
8
|
+
"unpkg": "dist/cinnamon.min.js",
|
|
9
|
+
"types": "dist/index.d.ts",
|
|
10
|
+
"files": [
|
|
11
|
+
"dist/*"
|
|
12
|
+
],
|
|
13
|
+
"scripts": {
|
|
14
|
+
"start": "rollup -c -w",
|
|
15
|
+
"build-lib": "rollup -c",
|
|
16
|
+
"storybook": "start-storybook -p 6006",
|
|
17
|
+
"build-storybook": "build-storybook"
|
|
18
|
+
},
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "https://github.com/cincoders/cinnamon"
|
|
22
|
+
},
|
|
23
|
+
"publishConfig": {
|
|
24
|
+
"access": "public"
|
|
25
|
+
},
|
|
26
|
+
"author": "",
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"@babel/core": "^7.14.3",
|
|
30
|
+
"@rollup/plugin-commonjs": "^19.0.0",
|
|
31
|
+
"@rollup/plugin-node-resolve": "^13.0.0",
|
|
32
|
+
"@storybook/addon-actions": "^6.5.9",
|
|
33
|
+
"@storybook/addon-essentials": "^6.5.9",
|
|
34
|
+
"@storybook/addon-links": "^6.5.9",
|
|
35
|
+
"@storybook/builder-webpack5": "^6.5.13",
|
|
36
|
+
"@storybook/manager-webpack5": "^6.5.13",
|
|
37
|
+
"@storybook/react": "^6.5.9",
|
|
38
|
+
"@types/jquery": "^3.5.5",
|
|
39
|
+
"@types/react": "^18.0.27",
|
|
40
|
+
"@types/react-dom": "^18.0.4",
|
|
41
|
+
"@types/react-router-dom": "^5.1.7",
|
|
42
|
+
"@types/styled-components": "^5.1.11",
|
|
43
|
+
"@typescript-eslint/eslint-plugin": "^4.29.1",
|
|
44
|
+
"@typescript-eslint/parser": "^4.29.1",
|
|
45
|
+
"babel-loader": "^8.2.2",
|
|
46
|
+
"eslint": "^7.32.0",
|
|
47
|
+
"eslint-config-airbnb": "^18.2.1",
|
|
48
|
+
"eslint-config-prettier": "^8.3.0",
|
|
49
|
+
"eslint-plugin-import": "^2.24.0",
|
|
50
|
+
"eslint-plugin-jsx-a11y": "^6.4.1",
|
|
51
|
+
"eslint-plugin-prettier": "^3.4.0",
|
|
52
|
+
"eslint-plugin-react": "^7.24.0",
|
|
53
|
+
"eslint-plugin-react-hooks": "^4.2.0",
|
|
54
|
+
"postcss-scss": "^3.0.5",
|
|
55
|
+
"prettier": "^2.3.2",
|
|
56
|
+
"react": "18.1",
|
|
57
|
+
"react-dom": "18.1",
|
|
58
|
+
"react-router-dom": "^6.3.0",
|
|
59
|
+
"rollup": "^2.51.1",
|
|
60
|
+
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
61
|
+
"rollup-plugin-postcss": "^4.0.2",
|
|
62
|
+
"rollup-plugin-terser": "^7.0.2",
|
|
63
|
+
"rollup-plugin-typescript2": "^0.30.0",
|
|
64
|
+
"typescript": "^4.3.2"
|
|
65
|
+
},
|
|
66
|
+
"peerDependencies": {
|
|
67
|
+
"react": "18.1",
|
|
68
|
+
"react-dom": "18.1",
|
|
69
|
+
"react-router-dom": "^6.3.0",
|
|
70
|
+
"react-transition-group": "^4.4.2"
|
|
71
|
+
},
|
|
72
|
+
"dependencies": {
|
|
73
|
+
"@emotion/react": "^11.9.3",
|
|
74
|
+
"@emotion/styled": "^11.10.5",
|
|
75
|
+
"@mui/icons-material": "^5.8.4",
|
|
76
|
+
"@mui/material": "^5.8.6",
|
|
77
|
+
"@react-keycloak/web": "^3.4.0",
|
|
78
|
+
"@rollup/plugin-url": "^6.1.0",
|
|
79
|
+
"jquery": "^3.6.0",
|
|
80
|
+
"keycloak-js": "^18.0.0",
|
|
81
|
+
"postcss": "^8.3.6",
|
|
82
|
+
"react-toastify": "^9.1.1",
|
|
83
|
+
"react-transition-group": "^4.4.2",
|
|
84
|
+
"styled-components": "^5.3.0"
|
|
85
|
+
},
|
|
86
|
+
"overrides": {
|
|
87
|
+
"chokidar": "3.5.3",
|
|
88
|
+
"glob-parent": "6.0.2",
|
|
89
|
+
"trim": "1.0.1",
|
|
90
|
+
"trim-newlines": "5.0.0"
|
|
91
|
+
}
|
|
92
|
+
}
|