@oncehub/ui-react 1.0.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 +45 -0
- package/package.json +47 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Oncehub
|
|
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,45 @@
|
|
|
1
|
+
# once-ui-react
|
|
2
|
+
|
|
3
|
+
React component library for Oncehub
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @oncehub/ui-react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Development
|
|
12
|
+
|
|
13
|
+
1. Storybook is [automatically deployed](https://github.com/scheduleonce/once-ui-react/actions/workflows/deploy-storybook.yml) to Github Pages when pushing to main
|
|
14
|
+
2. Package is automatically pushed to npm when [publishing a new package](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on Github
|
|
15
|
+
|
|
16
|
+
## Tools
|
|
17
|
+
|
|
18
|
+
- ⚛️ [React 18](https://reactjs.org/)
|
|
19
|
+
- 📚 [Storybook 7](https://storybook.js.org/) - Components preview
|
|
20
|
+
- 🖌️ [Tailwind CSS 3](https://tailwindcss.com/)
|
|
21
|
+
- ⏩ [Vite](https://vitejs.dev/) - Run and build the project blazingly fast!
|
|
22
|
+
- ⚡ [Vitest](https://vitest.dev/) - Components Unit Testing
|
|
23
|
+
- 📐 [ESLint](https://eslint.org/) & [Prettier](https://prettier.io/) - Formatting and Linting
|
|
24
|
+
- 🌟 [Typescript](https://www.typescriptlang.org/)
|
|
25
|
+
- 🐶 [Husky](https://typicode.github.io/husky) & [Lint Staged](https://www.npmjs.com/package/lint-staged) - Pre-commit Hooks
|
|
26
|
+
- ⏰ [Release Please](https://github.com/googleapis/release-please) — Generate the changelog with the release-please workflow
|
|
27
|
+
- 👷 [Github Actions](https://github.com/features/actions) — Releasing versions to npm
|
|
28
|
+
|
|
29
|
+
## Main Scripts
|
|
30
|
+
|
|
31
|
+
- `dev`: Bootstrap the Storybook preview with Hot Reload.
|
|
32
|
+
- `build`: Builds the static storybook project.
|
|
33
|
+
- `build:lib`: Builds the component library into the **dist** folder.
|
|
34
|
+
- `lint:fix`: Applies linting based on the rules defined in **.eslintrc.js**.
|
|
35
|
+
- `format:prettier`: Formats files using the prettier rules defined in **.prettierrc**.
|
|
36
|
+
- `test`: Runs testing using watch mode.
|
|
37
|
+
- `test:cov`: Runs testing displaying a coverage report.
|
|
38
|
+
|
|
39
|
+
## Acknowledgments
|
|
40
|
+
|
|
41
|
+
The project has been scaffolded using [vite-component-library-template](https://github.com/IgnacioNMiranda/vite-component-library-template)
|
|
42
|
+
|
|
43
|
+
## License
|
|
44
|
+
|
|
45
|
+
[MIT](LICENSE)
|
package/package.json
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@oncehub/ui-react",
|
|
3
|
+
"private": false,
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/scheduleonce/once-ui-react"
|
|
8
|
+
},
|
|
9
|
+
"main": "./dist/once-ui-react.umd.js",
|
|
10
|
+
"module": "./dist/once-ui-react.es.js",
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"import": "./dist/once-ui-react.es.js",
|
|
16
|
+
"require": "./dist/once-ui-react.umd.js"
|
|
17
|
+
},
|
|
18
|
+
"./dist/style.css": "./dist/style.css"
|
|
19
|
+
},
|
|
20
|
+
"engines": {
|
|
21
|
+
"node": "18"
|
|
22
|
+
},
|
|
23
|
+
"scripts": {
|
|
24
|
+
"dev": "storybook dev -p 6006",
|
|
25
|
+
"build": "storybook build",
|
|
26
|
+
"build:lib": "tsc && vite build",
|
|
27
|
+
"lint": "eslint --ext .js,.jsx,.ts,.tsx --fix",
|
|
28
|
+
"test:prettier": "prettier --check --ignore-unknown \"src/**/*.{ts,tsx,js,mdx}\"",
|
|
29
|
+
"fix:prettier": "prettier --write --ignore-unknown \"src/**/*.{ts,tsx,js,mdx}\"",
|
|
30
|
+
"test": "vitest",
|
|
31
|
+
"test:cov": "vitest run --coverage",
|
|
32
|
+
"prepare": "husky install",
|
|
33
|
+
"prepack": "json -f package.json -I -e \"delete this.devDependencies; delete this.dependencies\""
|
|
34
|
+
},
|
|
35
|
+
"peerDependencies": {
|
|
36
|
+
"react": "18.2.0",
|
|
37
|
+
"react-dom": "18.2.0"
|
|
38
|
+
},
|
|
39
|
+
"files": [
|
|
40
|
+
"dist"
|
|
41
|
+
],
|
|
42
|
+
"lint-staged": {
|
|
43
|
+
"*.{ts,tsx,js,jsx,json,css,md}": [
|
|
44
|
+
"prettier -w"
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
}
|