buildgrid-ui 1.0.0 → 1.1.0-alpha.2

package/.github/workflows/release.yml

@@ -3,6 +3,9 @@ on:
   push:
     branches:
       - main
+      - alpha
+      - beta
+      - rc
 jobs:
   release:
     runs-on: ubuntu-latest

package/.releaserc.json

@@ -1,5 +1,19 @@
 {
-  "branches": ["main"],
+  "branches": [
+    "main",
+    {
+      "name": "alpha",
+      "prerelease": "alpha"
+    },
+    {
+      "name": "beta",
+      "prerelease": "beta"
+    },
+    {
+      "name": "release-candidate",
+      "prerelease": "rc"
+    }
+  ],
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [1.1.0-alpha.1](https://github.com/adrianomaringolo/buildgrid-ui/compare/v1.0.0...v1.1.0-alpha.1) (2025-01-02)
+
+
+### Features
+
+* adding shadcn configuration ([5841434](https://github.com/adrianomaringolo/buildgrid-ui/commit/584143402fad7aa19e477693d2a4727f5625e430))
+* enhance Button component stories with props and update export ([69292b3](https://github.com/adrianomaringolo/buildgrid-ui/commit/69292b3d467dd5ed8eacf521e9c5f89e465af323))
+
 # 1.0.0 (2025-01-02)
 
 

package/README.md

@@ -0,0 +1,132 @@
+# buildgrid-ui
+
+### This lib is under construction, take a look again soon 🚧
+
+A React component library built using [Vite](https://vitejs.dev) and [shadcn](https://ui.shadcn.com/) as the foundation. This library is designed to integrate seamlessly with React and Next.js applications and includes support for [TailwindCSS](https://tailwindcss.com). It also provides a Storybook setup to display and document the components.
+
+## Features
+
+- **Built with Vite** for a fast development experience.
+- **TailwindCSS Integration** for utility-first styling.
+- **shadcn Components** as a robust base.
+- **Storybook** for component documentation and testing.
+- **Semantic Versioning** with automated releases using [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
+
+---
+
+## Getting Started
+
+### Installation
+
+To install the library, run:
+
+```bash
+npm install buildgrid-ui
+```
+
+or
+
+```bash
+yarn add buildgrid-ui
+```
+
+---
+
+### Usage
+
+1. Import a component in your React project:
+
+   ```jsx
+   import { Button } from "buildgrid-ui";
+
+   const App = () => <Button variant="primary">Click Me</Button>;
+
+   export default App;
+   ```
+
+2. Ensure TailwindCSS is configured in your project. Add the following imports to your `styles.css` file (or equivalent):
+
+   ```css
+   @tailwind base;
+   @tailwind components;
+   @tailwind utilities;
+   ```
+
+3. Include the `tailwind.config.js` content paths for buildgrid-ui:
+   ```javascript
+   module.exports = {
+     content: [
+       "./src/**/*.{js,ts,jsx,tsx}",
+       "./node_modules/buildgrid-ui/**/*.{js,ts,jsx,tsx}",
+     ],
+     theme: {
+       extend: {},
+     },
+     plugins: [],
+   };
+   ```
+
+---
+
+## Development
+
+### Setting Up the Project
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/yourusername/buildgrid-ui.git
+cd buildgrid-ui
+npm install
+```
+
+### Storybook
+
+Run Storybook locally to preview and develop components:
+
+```bash
+npm run storybook
+```
+
+---
+
+### Build the Library
+
+To build the library for production:
+
+```bash
+npm run build
+```
+
+The output will be in the `dist/` directory, ready for publishing or integration.
+
+---
+
+## Semantic Releases
+
+This project uses [semantic-release](https://semantic-release.gitbook.io/) for automated versioning and releases.
+
+### Steps to Create a Pre-release
+
+1. Push changes to the designated pre-release branch (e.g., `alpha`):
+   ```bash
+   git checkout -b alpha
+   git push origin alpha
+   ```
+2. Pre-release versions (e.g., `1.0.0-alpha.1`) will be automatically created.
+
+---
+
+## Contributing
+
+Contributions are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Submit a pull request with a detailed description of your changes.
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

package/components.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "default",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.js",
+    "css": "src/styles/tailwind.css",
+    "baseColor": "neutral",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  },
+  "iconLibrary": "lucide"
+}