set up jsrepo, readme, license

2026-03-07 06:29:30 -07:00 · 2025-07-09 10:15:05 +03:00
parent 8b35b43b08
commit ad6015691d
8 changed files with 2421 additions and 5 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -13,6 +13,7 @@ dist
 dist-ssr
 coverage
 *.local
+public/components

 /cypress/videos/
 /cypress/screenshots/
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# Contributing to Vue Bits
+
+Thank you for considering contributing to Vue Bits! I appreciate your interest in making this project better.
+
+To ensure a smooth collaboration, please read the following guidelines before getting started.
+
+## Issue Tracker
+
+We use the GitHub issue tracker to keep track of bugs, feature requests, and other project-related discussions. Before starting to work on a new feature or bug fix, please check the issue tracker to see if there's an existing issue or discussion related to it. If not, feel free to create a new issue.
+
+## Branch Naming
+
+When creating branches for your contributions, please follow the following naming convention:
+
+`feat/<feature-name>`
+
+For example, if you are working on a feature related to adding a new component, your branch name could be `feat/fix-x-component`. This naming convention helps us to easily track and associate contributions with their respective features.
+
+## Pull Requests
+
+We welcome pull requests from everyone as long as they respeect the quality standards of this project. To submit a pull request, please follow these steps:
+
+1. Fork the repository and create a new branch based on the branch naming convention mentioned above.
+2. Make your changes in the new branch.
+3. Submit a pull request to the main repository's `main` branch.
+4. Provide a clear and descriptive title for your pull request, along with a detailed description of the changes you have made, and screenshots/videos where possible.
+5. For components updates, ensure that changes are reflected in all related files (eg: Demo Components, Usage Examples, etc).
+6. Before you open a pull request, please make sure that your changes are tested locally, and everything looks good on desktop and mobile, also check the browser console for errors, and so on, so that we can keep this library at the highest quality possible.
+7. Any pull requests that fail to meet these requirements will be denied, so please make sure you respect them so that your work can go through.
+
+## Note
+
+New components from the community are currently not being accepted into the library, only component enhancements and bug fixes are open for contributions.
+
+## Conclusion
+
+I appreciate your interest in contributing! By following these guidelines, you can help us maintain a healthy and productive open-source community. I value your contributions and look forward to your pull requests!
+
+If you have any questions or need further assistance, please don't hesitate to reach out to us through the issue tracker or other communication channels mentioned in the project's documentation.
+
+Happy contributing!
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -0,0 +1,25 @@
+MIT + Commons Clause License Condition v1.0
+
+Copyright (c) 2025 David Haz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, and distribute the Software **as part of an application, website, or product**, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+## Commons Clause Restriction
+
+You may use this Software, including for any commercial purpose, **so long as you do not sell, sublicense, or redistribute the components themselves-whether alone, in a bundle, or as a ported version.**
+
+## No Warranty
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/README.md
+++ b/README.md
@@ -1,3 +1,73 @@
-# vue-bits
+<div align="center">
+	<br>
+	<br>
+    <picture>
+      <source media="(prefers-color-scheme: light)" srcset="src/assets/logos/vuebits-gh-black.svg">
+      <source media="(prefers-color-scheme: dark)" srcset="src/assets/logos/vuebits-gh-white.svg">
+      <img src="src/assets/logos/vuebits-gh-black.svg" alt="vue-bits logo" width="1000">
+    </picture>
+	<br>
+	<br>
+</div>

-WIP
+<div align="center">
+  The largest & most creative library of animated Vue components.
+</div>
+
+<br />
+
+<div align="center">
+  <a href="https://github.com/davidhdev/vue-bits/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/davidhdev/vue-bits"></a>
+  <a href="https://github.com/davidhdev/vue-bits/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/badge/License-MIT+Commons_Clause-green"></a>
+  
+</div>
+
+## Documentation
+
+Go to [vuebits.dev](https://vuebits.dev/) to view the documentation.
+
+## About
+
+Vue Bits is a large collection of animated Vue components made to spice up your web creations. We've got animations, components, backgrounds, and awesome stuff that you won't be able to find anywhere else - all free for you to use! These components are all enhanced with customization options as props, to make it easy for you to get exactly what you need.
+
+## Key Features
+
+- 40+ total components (text animations, animations, components, backgrounds), growing every week
+- All components have with minimal dependencies, and are highly customizable through props
+- Designed to integrate seamlessly with any modern Vue project
+
+## CLI (<a href="https://jsrepo.dev"><img src="https://jsrepo.dev/badges/jsrepo.svg" width="50" alt="jsrepo"></a>)
+
+Vue Bits uses [jsrepo](https://jsrepo.dev) for installing components via CLI. </br>
+The setup steps can be found on each component's page in the [documentation](https://vuebits.dev/).
+
+## How To Contribute?
+
+Contributions are welcome! Check the [Open Issues](https://github.com/DavidHDev/vue-bits/issues) to see how you can help or submit ideas using the [Feature Request template](https://github.com/DavidHDev/vue-bits/issues/new?template=2-feature-request.yml).</br>
+Please review the [Contribution Guide](https://github.com/DavidHDev/vue-bits/blob/main/CONTRIBUTING.md) and follow our standards. Thanks for your time!
+
+## Contributors
+
+<a href="https://github.com/davidhdev/vue-bits/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=davidhdev/vue-bits" />
+</a>
+
+## Maintainers
+
+[David Haz](https://github.com/DavidHDev)
+
+## Stats
+
+![Alt](https://repobeats.axiom.co/api/embed/02689c621a09cc5b492ccc1b4bb2f764e32500b7.svg "Repobeats analytics image")
+
+## Sponsorship
+
+You can help support the project by using the Sponsor button on the page - please note that any donations received will go strictly towards paying hosting costs, nothing else.
+
+## Credit
+
+Vue Bits may sometimes take inspiration from publicly available code examples online. These examples are rewritten as full-fledged, customizable, and reusable components. If you recognize your work here, just request credit and it will be granted.
+
+## License
+
+Licensed under the [MIT + Commons Clause license](https://github.com/davidhdev/vue-bits/blob/main/LICENSE.md).
--- a/jsrepo-build-config.json
+++ b/jsrepo-build-config.json
@@ -0,0 +1,37 @@
+{
+	"$schema": "https://unpkg.com/jsrepo@1.30.1/schemas/registry-config.json",
+	"meta": {
+		"authors": ["David Haz"],
+		"description": "An open source collection of animated, interactive & fully customizable Vue components for building stunning, memorable user interfaces.",
+		"bugs": "https://github.com/DavidHDev/vue-bits/issues",
+		"homepage": "https://vuebits.dev",
+		"repository": "https://github.com/DavidHDev/vue-bits",
+		"tags": [
+			"vue",
+			"javascript",
+			"components",
+			"web",
+			"vuejs",
+			"css-animations",
+			"component-library",
+			"ui-components",
+			"3d",
+			"ui-library",
+			"tailwind",
+			"tailwindcss",
+			"components",
+			"components-library"
+		]
+	},
+	"dirs": [],
+	"doNotListBlocks": [],
+	"doNotListCategories": [],
+	"listBlocks": [],
+	"listCategories": [],
+	"excludeDeps": ["vue"],
+	"includeBlocks": [],
+	"includeCategories": [],
+	"excludeBlocks": [],
+	"excludeCategories": [],
+	"preview": true
+}
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -5,11 +5,13 @@
  "type": "module",
  "scripts": {
    "dev": "vite",
-    "build": "run-p type-check \"build-only {@}\" --",
+    "build": "npm run build:registry && run-p type-check \"build-only {@}\" --",
+    "build:registry": "jsrepo build --dirs ./src/content --output-dir ./public/components",
    "preview": "vite preview",
    "build-only": "vite build",
    "type-check": "vue-tsc --build",
-    "lint": "eslint . --fix"
+    "lint": "eslint . --fix",
+    "new:component": "node scripts/generateComponent.js"
  },
  "dependencies": {
    "@primeuix/themes": "^1.2.1",
@@ -40,6 +42,7 @@
    "typescript": "~5.8.0",
    "vite": "^7.0.0",
    "vite-plugin-vue-devtools": "^7.7.7",
-    "vue-tsc": "^2.2.10"
+    "vue-tsc": "^2.2.10",
+		"jsrepo": "^1.30.1"
  }
 }
--- a/wrangler.jsonc
+++ b/wrangler.jsonc
@@ -0,0 +1,8 @@
+{
+  "name": "vue-bits",
+  "compatibility_date": "2025-06-15",
+  "assets": {
+    "directory": "./dist",
+    "not_found_handling": "single-page-application"
+  }
+}