-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
<p align="center"> | ||
<img src="https://res.cloudinary.com/dt8onsdfl/image/upload/v1694478376/hawa-logo-white-bg.jpg" alt="Hawa | هواء" /> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://hawa.style/docs">Documentation</a> - | ||
<a href="https://github.com/sikka-software/Hawa/blob/main/CHANGELOG.md">Changelog</a> | ||
<!-- <a href="https://hawa.style/roadmap">Roadmap</a> --> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://www.npmjs.com/package/@sikka/hawa"> | ||
<img src="https://img.shields.io/npm/v/@sikka/hawa.svg?style=flat&colorA=000000&colorB=1082c3" alt="npm"/> | ||
</a> | ||
<a href="https://www.npmjs.com/package/@sikka/hawa"> | ||
<img src="https://img.shields.io/npm/v/@sikka/hawa/next.svg?style=flat&colorA=000000&colorB=ea7637" alt="@next tag"/> | ||
</a> | ||
<br /> | ||
<a href="https://github.com/sikka-software/Hawa/actions/workflows/hawa-main.yml"> | ||
<img src="https://github.com/sikka-software/Hawa/actions/workflows/publish-production.yml/badge.svg" alt="@latest tag"/> | ||
</a> | ||
<a href="https://github.com/sikka-software/Hawa/actions/workflows/hawa-beta.yml"> | ||
<img src="https://github.com/sikka-software/Hawa/actions/workflows/publish-beta.yml/badge.svg" alt="@next tag"/> | ||
</a> | ||
<br/> | ||
<a href="https://storybook.hawa.style" target="_blank"><img src="https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg"></a> | ||
</p> | ||
|
||
--- | ||
|
||
<p style="font-size: 40px; font-weight: 500" align="center">Hawa | هــواء</p> | ||
<p align="center">Opinionated UI Kit for web apps and websites built with TailwindCSS</p> | ||
|
||
--- | ||
|
||
### Tools used | ||
|
||
- Styling: [Tailwind](https://tailwindcss.com/) | ||
- Headless UI: [Radix-UI](https://www.radix-ui.com/) | ||
- Forms: [react-hook-form](https://react-hook-form.com/) | ||
- Tables: [@tanstack/react-table](https://tanstack.com/table/v8) | ||
- Form Validation: [zod](https://zod.dev/) | ||
- Phone Validation: [libphonenumber-js](https://gitlab.com/catamphetamine/libphonenumber-js) | ||
- Carousel: [embla-carousel-react](https://www.embla-carousel.com/) | ||
- Combobox: [cmdk](https://github.com/pacocoursey/cmdk) | ||
|
||
## Install | ||
|
||
**Note:** Current npm tags 👇 | ||
|
||
`@beta` is archived. | ||
|
||
`@next` only points to pre-releases. | ||
|
||
`@latest` for the latest stable release. | ||
|
||
```bash | ||
npm install @sikka/hawa | ||
``` | ||
|
||
</br> | ||
|
||
## Contributing | ||
|
||
Please see our [contributing.md](/CONTRIBUTING.md). | ||
|
||
## Inspiration | ||
|
||
[shadcn-ui](https://github.com/shadcn-ui/ui), [mantine](https://github.com/mantinedev/mantine), and [nextui](https://github.com/nextui-org/nextui) | ||
|
||
</br> | ||
|
||
 | ||
|
||
## License | ||
|
||
MIT © [SIKKA SOFTWARE](https://sikka.sa) | ||
|
||
<!--start: logo--> | ||
<p align="center"> | ||
<a href="https://sikka.io"> | ||
<img width="44" alt="Sikka" src="https://i.postimg.cc/8cK4tnKQ/sikka-symbol-black.png"> | ||
</a> | ||
</p> | ||
<p align="center"> | ||
<sub>An open source project by <a href="https://sikka.io">Sikka</a></sub> | ||
</p> | ||
<!--end: logo--> |