astro-reactive-form/README.md
2022-10-04 13:00:29 +02:00

74 lines
4 KiB
Markdown

![Astro Reactive Library](https://user-images.githubusercontent.com/4262489/193419437-6e437743-47bf-482b-8f7e-de3c7f5285f8.png)
[![npm](https://img.shields.io/npm/v/astro-reactive-form)](https://www.npmjs.com/package/astro-reactive-form)
[![npm](https://img.shields.io/npm/l/astro-reactive-form)](https://www.npmjs.com/package/astro-reactive-form)
[![npm](https://img.shields.io/npm/dt/astro-reactive-form)](https://www.npmjs.com/package/astro-reactive-form)
[![github](https://img.shields.io/github/last-commit/ayoayco/astro-reactive-library)](https://github.com/ayoayco/astro-reactive-library)
# Components and utilities for building reactive user interfaces 🔥
Let your data build your UI. Blazing-fast, reactive user interfaces with native [Astro](https://astro.build) components and architecture.
| Packages | Version | Docs | Description |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------- |
| [astro-reactive-form](https://github.com/ayoayco/astro-reactive-library/tree/main/packages/astro-reactive-form#readme) | [![npm](https://img.shields.io/npm/v/astro-reactive-form)](https://www.npmjs.com/package/astro-reactive-form) | 🛠 in-progress | generate a dynamic form which can be modified programatically |
| astro-reactive-validator | 🛠 in-progress | 🛠 in-progress | set of utilities for validating inputs |
| astro-reactive-datagrid | 🛠 in-progress | 🛠 in-progress | generate a dynamic datagrid or table of values |
# HACKTOBERFEST 2022
[Hacktoberfest](https://hacktoberfest.com) has begun! 🚀
Any contribution is welcome. See our [contributing guide](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md), and feel free to look around to find something that interests you. :)
Maybe add some themes to our form component? Or maybe an improvement for the README?
The [issues page](https://github.com/ayoayco/astro-reactive-library/issues) contains some ideas, but they should not limit your contribution.
If you don't find anything there, I'm happy to help you get your contribution in.
You can always [create a new issue](https://github.com/ayoayco/astro-reactive-library/issues/new) for your own idea, [email me](mailto:ramon.aycojr+hack@gmail.com) or message me on [Twitter (@ayoayco)](https://twitter.com/ayoayco).
# Running locally
We mainly use the `demo` app to see changes we make on the packages. Do the following to start hacking:
1. Fork the project then clone to your computer
```
git clone git@github.com:<your-user-name>/astro-reactive-library.git
```
2. Go into the project directory
```
cd astro-reactive-library
```
3. Install the node dependencies
```
npm i
```
4. Run the demo application
```
npm run dev
```
5. Open the demo application on you browser. Browse to the address:
```
https://localhost:3000
```
_[Please report issues and suggestions](https://github.com/ayoayco/astro-reactive-library/issues)_
# Contributors
<a href="https://github.com/ayoayco/astro-reactive-library/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ayoayco/astro-reactive-library" />
</a>
👉 _[Join our contributors!](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md)_