4dc020027f
* feat: initial validator component * chore: fix eslint for validator * chore: update package info for validator * chore: remove vscode settings for docs * chore: put docs and demo into apps * chore: move package scope @astro-reactive * test: update tests for validator * feat: validator functions, hooks * feat: validator sets haserrors attribute * feat: use data-validator attributes * feat: showValidationHints * feature: add logic for all validators * refactor: remove Validator component usage * docs(validator): initial readme * chore: comment out unsupported validator * docs(validator): update installation * chore: package docs and publish * chore: update deps * docs: update npm info on docs * docs(validator): update docs for validator * fix(form): handle undefined form * test(validator): update tests * chore: organize files; update deps * chore: fix build scripts
86 lines
3.2 KiB
Markdown
86 lines
3.2 KiB
Markdown
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/ayoayco/astro-reactive-library/main/.github/assets/logo/min-banner.png" alt="Astro Reactive Library Logo">
|
|
<strong>Astro Reactive Library</strong>
|
|
<br />
|
|
Let your data build your UI with native <a href="https://astro.build">Astro</a> components and architecture.
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/ayoayco/astro-reactive-library/actions/workflows/build-and-test.yml">
|
|
<img src="https://github.com/ayoayco/astro-reactive-library/actions/workflows/build-and-test.yml/badge.svg?branch=main" alt="Build & Test Result" />
|
|
</a>
|
|
<a href="https://github.com/ayoayco/astro-reactive-library">
|
|
<img alt="Last Commit" src="https://img.shields.io/github/last-commit/ayoayco/astro-reactive-library" />
|
|
</a>
|
|
<br />
|
|
<br />
|
|
<p>
|
|
|
|
| Packages | Version | Docs | Description |
|
|
| --- | --- | --- | --- |
|
|
| [@astro-reactive/form](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/form/README.md) | [](https://www.npmjs.com/package/@astro-reactive/form) | 🛠 | generate a dynamic form which can be modified programatically |
|
|
| [@astro-reactive/validator](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/validator/README.md)|  | 🛠 | set up validators for your form easily |
|
|
| astro-reactive-datagrid | 🛠 | 🛠 | 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/choose) for your own idea, [email me (ayo@ayco.io)](mailto:ayo@ayco.io) 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 start
|
|
```
|
|
|
|
5. Open the demo application on you browser. Browse to the address:
|
|
|
|
```
|
|
https://localhost:3000
|
|
```
|
|
|
|
6. To run the tests:
|
|
|
|
```
|
|
npm test
|
|
```
|
|
|
|
_[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)_
|