@beweco/aurora-ui 0.0.1

package/README.md

@@ -0,0 +1,137 @@
+# @bewe/aura-ui
+
+Bewe Aura UI Component Library - A modern, lightweight, and customizable React component library.
+
+## Overview
+
+@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.
+
+## Installation
+
+```bash
+bun install @bewe/aura-ui
+```
+
+## Quick Start
+
+To use the components, you need to wrap your application with the `ThemeProvider` .
+
+```tsx
+import { ThemeProvider } from '@bewe/aura-ui';
+import { Button } from '@bewe/aura-ui';
+
+function App() {
+  return (
+    <ThemeProvider>
+      <Button color="primary">
+        Hello Aura UI!
+      </Button>
+    </ThemeProvider>
+  );
+}
+```
+
+## Development
+
+### Prerequisites
+
+- Bun (v1.0 or higher)
+
+### Setup
+
+1. Clone the repository:
+   ```bash
+   git clone <repository-url>
+   ```
+2. Install dependencies:
+   ```bash
+   bun install
+   ```
+
+### Development with Storybook
+
+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.
+
+To start the Storybook server, run:
+```bash
+bun run storybook
+```
+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.
+
+### Available Scripts
+
+- `bun run storybook` - Starts the Storybook development server.
+- `bun run build` - Builds the library for production.
+- `bun run dev` - Builds the library and watches for changes.
+- `bun run check` - Runs Biome to check for lint issues and apply safe fixes.
+- `bun run format` - Formats the entire codebase using Biome.
+- `bun run build:storybook` - Builds a static version of the Storybook site.
+
+## Publishing
+
+### Preparing a New Release
+
+1. Update version in `package.json`:
+   ```bash
+   bun version patch  # for bug fixes (0.0.x)
+   bun version minor  # for new features (0.x.0)
+   bun version major  # for breaking changes (x.0.0)
+   ```
+
+2. Build the library:
+   ```bash
+   bun run build
+   ```
+
+
+### Publishing to NPM Registry
+
+1. Login to npm (if not already logged in):
+   ```bash
+   npm login
+   ```
+
+2. Publish the package:
+   ```bash
+   npm publish --access public
+   ```
+   *Note: Although the project uses `bun`, publishing is typically done via `npm`.*
+
+### Publishing a Beta Version
+
+For testing purposes, you can publish a beta version:
+
+1. Tag the version as beta in `package.json`:
+   ```bash
+   bun version prerelease --preid=beta
+   ```
+
+2. Publish with the beta tag:
+   ```bash
+   npm publish --tag beta --access public
+   ```
+
+Users can then install the beta version using:
+```bash
+bun install @bewe/aura-ui@beta
+```
+
+## Contributing
+
+We welcome contributions! Please read our contributing guidelines before submitting pull requests.
+
+### Development Workflow
+
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/my-new-feature`).
+3. Make your changes in the `src` directory. Create or update stories in the `stories` directory.
+4. Use `bun run storybook` to visualize your changes.
+5. Submit a pull request.
+
+## License
+
+MIT License.
+
+## Support
+
+For support, please open an issue in the repository or contact the Bewe team.

package/package.json

@@ -0,0 +1,70 @@
+{
+	"name": "@beweco/aurora-ui",
+	"version": "0.0.1",
+	"description": "Bewe Aura UI Component Library",
+	"keywords": ["ui", "components", "react", "bewe", "aura"],
+	"sideEffects": false,
+	"type": "module",
+	"publishConfig": {
+		"access": "public"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/esm/index.d.ts",
+			"import": "./dist/esm/index.js",
+			"require": "./dist/cjs/index.cjs"
+		}
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.js",
+	"types": "./dist/esm/index.d.ts",
+	"files": ["dist"],
+	"author": "Bewe",
+	"license": "MIT",
+	"scripts": {
+		"build": "rslib build",
+		"build:storybook": "storybook build",
+		"check": "biome check --write",
+		"dev": "rslib build --watch",
+		"format": "biome format --write",
+		"preview": "rsbuild preview",
+		"storybook": "storybook dev --port 6006",
+		"chromatic": "npx chromatic --project-token=chpt_a33f7fd2ebb3349",
+		"prepare": "husky"
+	},
+	"peerDependencies": {
+		"@heroui/react": "^2.7.10",
+		"@heroui/system": "^2.4.15",
+		"@heroui/theme": "^2.4.15",
+		"@iconify/react": "^6.0.0",
+		"framer-motion": "^12.14.0",
+		"react": ">=18.0.0",
+		"react-dom": ">=18.0.0",
+		"tailwindcss": "^3.4.17"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^1.9.4",
+		"@rsbuild/core": "^1.3.22",
+		"@rsbuild/plugin-react": "^1.3.2",
+		"@rsbuild/plugin-sass": "^1.3.1",
+		"@rslib/core": "^0.4.1",
+		"@storybook/addon-essentials": "^8.0.0",
+		"@storybook/addon-interactions": "^8.0.0",
+		"@storybook/addon-links": "^8.0.0",
+		"@storybook/addon-themes": "^8.0.0",
+		"@storybook/blocks": "^8.0.0",
+		"@storybook/react": "^8.0.0",
+		"@storybook/react-vite": "^8.0.0",
+		"@storybook/test": "^8.0.0",
+		"@types/node": "^24.0.3",
+		"@types/react": "^19.1.5",
+		"@types/react-dom": "^19.1.5",
+		"autoprefixer": "^10.4.21",
+		"chromatic": "^13.0.0",
+		"husky": "^9.1.7",
+		"postcss": "^8.5.5",
+		"postcss-loader": "^8.1.1",
+		"storybook": "^8.0.0",
+		"typescript": "^5.8.3"
+	}
+}