@beweco/aurora-ui 0.0.1
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/README.md +137 -0
- package/package.json +70 -0
package/README.md
ADDED
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# @bewe/aura-ui
|
|
2
|
+
|
|
3
|
+
Bewe Aura UI Component Library - A modern, lightweight, and customizable React component library.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
@bewe/aura-ui is a React component library designed to provide a consistent and beautiful user interface for Bewe applications. Built with TypeScript for type safety and modern development practices, it uses Storybook as its primary development and visualization environment.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
bun install @bewe/aura-ui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
To use the components, you need to wrap your application with the `ThemeProvider` .
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import { ThemeProvider } from '@bewe/aura-ui';
|
|
21
|
+
import { Button } from '@bewe/aura-ui';
|
|
22
|
+
|
|
23
|
+
function App() {
|
|
24
|
+
return (
|
|
25
|
+
<ThemeProvider>
|
|
26
|
+
<Button color="primary">
|
|
27
|
+
Hello Aura UI!
|
|
28
|
+
</Button>
|
|
29
|
+
</ThemeProvider>
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Development
|
|
35
|
+
|
|
36
|
+
### Prerequisites
|
|
37
|
+
|
|
38
|
+
- Bun (v1.0 or higher)
|
|
39
|
+
|
|
40
|
+
### Setup
|
|
41
|
+
|
|
42
|
+
1. Clone the repository:
|
|
43
|
+
```bash
|
|
44
|
+
git clone <repository-url>
|
|
45
|
+
```
|
|
46
|
+
2. Install dependencies:
|
|
47
|
+
```bash
|
|
48
|
+
bun install
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Development with Storybook
|
|
52
|
+
|
|
53
|
+
This project uses [Storybook](https://storybook.js.org/) for component development and visualization. Storybook provides an isolated environment to build, view, and test components in real-time.
|
|
54
|
+
|
|
55
|
+
To start the Storybook server, run:
|
|
56
|
+
```bash
|
|
57
|
+
bun run storybook
|
|
58
|
+
```
|
|
59
|
+
This will open the Storybook interface in your browser, where you can browse all the available components, see their different states (variants, sizes, etc.), and interact with them.
|
|
60
|
+
|
|
61
|
+
### Available Scripts
|
|
62
|
+
|
|
63
|
+
- `bun run storybook` - Starts the Storybook development server.
|
|
64
|
+
- `bun run build` - Builds the library for production.
|
|
65
|
+
- `bun run dev` - Builds the library and watches for changes.
|
|
66
|
+
- `bun run check` - Runs Biome to check for lint issues and apply safe fixes.
|
|
67
|
+
- `bun run format` - Formats the entire codebase using Biome.
|
|
68
|
+
- `bun run build:storybook` - Builds a static version of the Storybook site.
|
|
69
|
+
|
|
70
|
+
## Publishing
|
|
71
|
+
|
|
72
|
+
### Preparing a New Release
|
|
73
|
+
|
|
74
|
+
1. Update version in `package.json`:
|
|
75
|
+
```bash
|
|
76
|
+
bun version patch # for bug fixes (0.0.x)
|
|
77
|
+
bun version minor # for new features (0.x.0)
|
|
78
|
+
bun version major # for breaking changes (x.0.0)
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
2. Build the library:
|
|
82
|
+
```bash
|
|
83
|
+
bun run build
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Publishing to NPM Registry
|
|
88
|
+
|
|
89
|
+
1. Login to npm (if not already logged in):
|
|
90
|
+
```bash
|
|
91
|
+
npm login
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
2. Publish the package:
|
|
95
|
+
```bash
|
|
96
|
+
npm publish --access public
|
|
97
|
+
```
|
|
98
|
+
*Note: Although the project uses `bun`, publishing is typically done via `npm`.*
|
|
99
|
+
|
|
100
|
+
### Publishing a Beta Version
|
|
101
|
+
|
|
102
|
+
For testing purposes, you can publish a beta version:
|
|
103
|
+
|
|
104
|
+
1. Tag the version as beta in `package.json`:
|
|
105
|
+
```bash
|
|
106
|
+
bun version prerelease --preid=beta
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
2. Publish with the beta tag:
|
|
110
|
+
```bash
|
|
111
|
+
npm publish --tag beta --access public
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Users can then install the beta version using:
|
|
115
|
+
```bash
|
|
116
|
+
bun install @bewe/aura-ui@beta
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Contributing
|
|
120
|
+
|
|
121
|
+
We welcome contributions! Please read our contributing guidelines before submitting pull requests.
|
|
122
|
+
|
|
123
|
+
### Development Workflow
|
|
124
|
+
|
|
125
|
+
1. Fork the repository.
|
|
126
|
+
2. Create a feature branch (`git checkout -b feature/my-new-feature`).
|
|
127
|
+
3. Make your changes in the `src` directory. Create or update stories in the `stories` directory.
|
|
128
|
+
4. Use `bun run storybook` to visualize your changes.
|
|
129
|
+
5. Submit a pull request.
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
MIT License.
|
|
134
|
+
|
|
135
|
+
## Support
|
|
136
|
+
|
|
137
|
+
For support, please open an issue in the repository or contact the Bewe team.
|
package/package.json
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@beweco/aurora-ui",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Bewe Aura UI Component Library",
|
|
5
|
+
"keywords": ["ui", "components", "react", "bewe", "aura"],
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"type": "module",
|
|
8
|
+
"publishConfig": {
|
|
9
|
+
"access": "public"
|
|
10
|
+
},
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./dist/esm/index.d.ts",
|
|
14
|
+
"import": "./dist/esm/index.js",
|
|
15
|
+
"require": "./dist/cjs/index.cjs"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"main": "./dist/cjs/index.cjs",
|
|
19
|
+
"module": "./dist/esm/index.js",
|
|
20
|
+
"types": "./dist/esm/index.d.ts",
|
|
21
|
+
"files": ["dist"],
|
|
22
|
+
"author": "Bewe",
|
|
23
|
+
"license": "MIT",
|
|
24
|
+
"scripts": {
|
|
25
|
+
"build": "rslib build",
|
|
26
|
+
"build:storybook": "storybook build",
|
|
27
|
+
"check": "biome check --write",
|
|
28
|
+
"dev": "rslib build --watch",
|
|
29
|
+
"format": "biome format --write",
|
|
30
|
+
"preview": "rsbuild preview",
|
|
31
|
+
"storybook": "storybook dev --port 6006",
|
|
32
|
+
"chromatic": "npx chromatic --project-token=chpt_a33f7fd2ebb3349",
|
|
33
|
+
"prepare": "husky"
|
|
34
|
+
},
|
|
35
|
+
"peerDependencies": {
|
|
36
|
+
"@heroui/react": "^2.7.10",
|
|
37
|
+
"@heroui/system": "^2.4.15",
|
|
38
|
+
"@heroui/theme": "^2.4.15",
|
|
39
|
+
"@iconify/react": "^6.0.0",
|
|
40
|
+
"framer-motion": "^12.14.0",
|
|
41
|
+
"react": ">=18.0.0",
|
|
42
|
+
"react-dom": ">=18.0.0",
|
|
43
|
+
"tailwindcss": "^3.4.17"
|
|
44
|
+
},
|
|
45
|
+
"devDependencies": {
|
|
46
|
+
"@biomejs/biome": "^1.9.4",
|
|
47
|
+
"@rsbuild/core": "^1.3.22",
|
|
48
|
+
"@rsbuild/plugin-react": "^1.3.2",
|
|
49
|
+
"@rsbuild/plugin-sass": "^1.3.1",
|
|
50
|
+
"@rslib/core": "^0.4.1",
|
|
51
|
+
"@storybook/addon-essentials": "^8.0.0",
|
|
52
|
+
"@storybook/addon-interactions": "^8.0.0",
|
|
53
|
+
"@storybook/addon-links": "^8.0.0",
|
|
54
|
+
"@storybook/addon-themes": "^8.0.0",
|
|
55
|
+
"@storybook/blocks": "^8.0.0",
|
|
56
|
+
"@storybook/react": "^8.0.0",
|
|
57
|
+
"@storybook/react-vite": "^8.0.0",
|
|
58
|
+
"@storybook/test": "^8.0.0",
|
|
59
|
+
"@types/node": "^24.0.3",
|
|
60
|
+
"@types/react": "^19.1.5",
|
|
61
|
+
"@types/react-dom": "^19.1.5",
|
|
62
|
+
"autoprefixer": "^10.4.21",
|
|
63
|
+
"chromatic": "^13.0.0",
|
|
64
|
+
"husky": "^9.1.7",
|
|
65
|
+
"postcss": "^8.5.5",
|
|
66
|
+
"postcss-loader": "^8.1.1",
|
|
67
|
+
"storybook": "^8.0.0",
|
|
68
|
+
"typescript": "^5.8.3"
|
|
69
|
+
}
|
|
70
|
+
}
|