From a738518914fc02336365b71cf7464fb66fab0bd4 Mon Sep 17 00:00:00 2001 From: MGREMY Date: Sun, 27 Oct 2024 18:23:44 +0100 Subject: [PATCH 1/2] chore: move readme --- libs/flowbite-angular/README.md | 376 ++++++++++++++++++++++++++++++++ 1 file changed, 376 insertions(+) create mode 100644 libs/flowbite-angular/README.md diff --git a/libs/flowbite-angular/README.md b/libs/flowbite-angular/README.md new file mode 100644 index 00000000..89cedaa2 --- /dev/null +++ b/libs/flowbite-angular/README.md @@ -0,0 +1,376 @@ +
+

:construction: flowbite-angular (unreleased) :construction:

+

+ + Flowbite - Tailwind CSS components + +

+

+ Build websites even faster with components on top of Angular and Tailwind CSS +

+

+ + Discord + + + Total Downloads + + + Latest release + + + License + +

+
+ +--- + +**`flowbite-angular` is an open source collection of UI components, built in Angular, with utility classes from Tailwind CSS that you can use as a starting point for user interfaces and websites.** + +## Table of Contents + +- [Documentation](#documentation) +- [Getting started](#getting-started) +- [Components](#components) +- [Community](#community) +- [Contributing](#contributing) +- [Figma](#figma) +- [Copyright and license](#copyright-and-license) + +## Documentation + +Documentation for `flowbite-angular` is not yet finished. + +If you want to browse the components, visit [flowbite-angular.com](https://flowbite-angular.com/). + +If you want to learn more about Flowbite, visit [Flowbite docs](https://flowbite.com/docs/getting-started/introduction/). + +## Getting started + +To use `flowbite-angular`, you just need to setup `flowbite` normally and install `flowbite-angular` from `npm`. + +`flowbite` can be included as a plugin into an existing Tailwind CSS project. + +### Require via `npm` + +Make sure that you have Node.js and Tailwind CSS installed. + +1. Install `flowbite` as a dependency using `npm` by running the following command: + +```bash +npm i flowbite flowbite-angular +``` + +2. Require `flowbite` as a plugin inside the `tailwind.config.js` file: + +```javascript +module.exports = { + plugins: [require('flowbite/plugin')], +}; +``` + +## Components + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AlertsBadges:construction: Breadcrumbs
+ + Tailwind CSS Alerts + + + + Tailwind CSS Badge + + + + Tailwind CSS Breadcrumbs + +
:construction: Buttons:construction: Button group:construction: Cards
+ + Tailwind CSS Buttons + + + + Tailwind CSS Button Group + + + + Tailwind CSS Cards + +
:construction: Dropdown:construction: Forms:construction: List group
+ + Tailwind CSS Dropdown + + + + Tailwind CSS Forms + + + + Tailwind CSS List group + +
:construction: Typography:construction: Modal:construction: Tabs
+ + Tailwind CSS Typography + + + + Tailwind CSS Modal + + + + Tailwind CSS Tabs + +
:construction: Navbar:construction: Pagination:construction: Timeline
+ + Tailwind CSS Navbar + + + + Tailwind CSS Pagination + + + + Tailwind CSS Timeline + +
:construction: Progress bar:construction: Tables:construction: Toast
+ + Tailwind CSS Progress Bar + + + + Tailwind CSS Tables + + + + Tailwind CSS Toast + +
:construction: Tooltips:construction: Datepicker:construction: Spinner
+ + Tailwind CSS Tooltips + + + + Tailwind CSS Datepicker + + + + Tailwind CSS Spinner + +
:construction: Footer:construction: Accordion:construction: Sidebar
+ + Tailwind CSS Footer + + + + Tailwind CSS Accordion + + + + Tailwind CSS Sidebar + +
:construction: Carousel:construction: Avatar:construction: Rating
+ + Tailwind CSS Carousel + + + + Tailwind CSS Avatar + + + + Tailwind CSS Rating + +
:construction: Input Field:construction: File Input:construction: Search Input
+ + Tailwind CSS Input Field + + + + Tailwind CSS File Input + + + + Tailwind CSS Search Input + +
:construction: Select:construction: Textarea:construction: Checkbox
+ + Tailwind CSS Select + + + + Tailwind CSS Textarea + + + + Tailwind CSS Checkbox + +
:construction: Radio:construction: Toggle:construction: Range Slider
+ + Tailwind CSS Radio + + + + Tailwind CSS Toggle + + + + Tailwind CSS Range Slider + +
:construction: Floating Label
+ + Tailwind CSS Floating Label + +
+ +## Community + +If you need help or just want to discuss the library join the community on GitHub: + +⌨️ [Discuss Flowbite on GitHub](https://github.com/themesberg/flowbite/discussions) + +For casual chatting with others using the library: + +💬 [Join the Flowbite Discord Server](https://discord.gg/4eeurUVvTy) + +## Contributing + +Thank you for your interest in helping! Visit our [guide on contributing](https://github.com/themesberg/flowbite-angular/blob/main/CONTRIBUTING.md) to get started. + +## Figma + +If you need the Figma files for the components you can check out our website for more information: + +🎨 [Get access to the Figma design files](https://flowbite.com/figma/) + +## Copyright and license + +The Flowbite name and logos are trademarks of Crafty Dwarf Inc. + +📝 [Read about the licensing terms](https://flowbite.com/docs/getting-started/license/) From b02ae483413dadf74ed8ebd012adeacb92972b89 Mon Sep 17 00:00:00 2001 From: MGREMY Date: Sun, 27 Oct 2024 18:29:50 +0100 Subject: [PATCH 2/2] fix: assets while building library --- libs/flowbite-angular/LICENSE | 21 +++++++++++++++++++++ libs/flowbite-angular/ng-package.json | 3 ++- package.json | 2 +- 3 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 libs/flowbite-angular/LICENSE diff --git a/libs/flowbite-angular/LICENSE b/libs/flowbite-angular/LICENSE new file mode 100644 index 00000000..82da9c1f --- /dev/null +++ b/libs/flowbite-angular/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Themesberg + +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, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, 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. + +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. diff --git a/libs/flowbite-angular/ng-package.json b/libs/flowbite-angular/ng-package.json index f0adf64b..e51432f5 100644 --- a/libs/flowbite-angular/ng-package.json +++ b/libs/flowbite-angular/ng-package.json @@ -3,5 +3,6 @@ "dest": "../../dist/libs/flowbite-angular", "lib": { "entryFile": "common/index.ts" - } + }, + "assets": ["tailwind.config.js", "README.md", "LICENSE"] } diff --git a/package.json b/package.json index 04820f0a..0b67599d 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "format": "prettier --write \"**/*.{ts,html,scss,js,json}\"", "format:check": "prettier --check \"**/*.{ts,html,scss,js,json}\"", "preinstall": "pnpm dlx only-allow pnpm", - "lib:build": "nx run flowbite-angular:build && cp README.md LICENSE libs/flowbite-angular/tailwind.config.js dist/libs/flowbite-angular", + "lib:build": "nx run flowbite-angular:build", "lib:lint": "nx run flowbite-angular:lint", "lib:release": "nx run flowbite-angular:semantic-release", "lib:test": "nx run flowbite-angular:test",