ayo/astro-reactive-form
ayo/astro-reactive-form
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update links to the repository (#247)

Browse source 
* Link to repo updated

* Update introduction.md

* docs: update links to change logs

Co-authored-by: Ayo <ramon.aycojr@gmail.com>
This commit is contained in:
Madhav Setia 2023-01-04 16:18:37 +05:30 committed by GitHub
parent 814692d9c9
commit dd285e72a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 100 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
CONTRIBUTING.md
View file

@ -1,6 +1,7 @@
![Astro Reactive Library](https://user-images.githubusercontent.com/4262489/193419437-6e437743-47bf-482b-8f7e-de3c7f5285f8.png)
# Hi, explorer! 🚀
Thanks for checking out the Astro Reactive Library! Welcome to a new adventure.
This is a library of components and utilities for building reactive user interfaces with [Astro](https://astro.build)--a modern web framework.
@ -11,11 +12,11 @@ There's a lot of opportunity to contribute. A good start will be to understand w
Any contribution is welcome. Feel free to look around to find something that interests you. :)
The [issues page](https://github.com/ayoayco/astro-reactive-library/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+PRs%22) contains some ideas, but they should not limit your contribution.
The [issues page](https://github.com/astro-reactive/astro-reactive/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+PRs%22) contains some ideas, but they should not limit your contribution.
If you don't find anything there, we are 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, [post on our discussions](https://github.com/ayoayco/astro-reactive-library/discussions) or join our [Discord](https://discord.gg/yKyzCjNK).
You can always [create a new issue](https://github.com/astro-reactive/astro-reactive/issues/new/choose) for your own idea, [post on our discussions](https://github.com/astro-reactive/astro-reactive/discussions) or join our [Discord](https://discord.gg/yKyzCjNK).
# The Astro Reactive Library
@ -26,18 +27,20 @@ The project is made up of [NPM workspaces](https://docs.npmjs.com/cli/v7/using-n
We are using [Turborepo](https://turbo.build/repo) as our monorepo build system.
Packages:
1. [demo](https://github.com/ayoayco/astro-reactive-library/tree/main/apps/demo) in the directory `apps/demo`
1. [demo](https://github.com/astro-reactive/astro-reactive/tree/main/apps/demo) in the directory `apps/demo`
- Astro web application that we use to test and demonstrate the library components
1. [form](https://github.com/ayoayco/astro-reactive-library/tree/main/packages/form) in the directory `packages/form`
1. [form](https://github.com/astro-reactive/astro-reactive/tree/main/packages/form) in the directory `packages/form`
- component that allows developers to programmatically build a form
1. [validator](https://github.com/ayoayco/astro-reactive-library/tree/main/packages/validator) in the directory `packages/astro-reactive-validator`
1. [validator](https://github.com/astro-reactive/astro-reactive/tree/main/packages/validator) in the directory `packages/astro-reactive-validator`
- component that allows developers to set up validators for their forms easily
1. [docs](https://github.com/ayoayco/astro-reactive-library/tree/main/apps/docs) - in the directory `apps/docs`
1. [docs](https://github.com/astro-reactive/astro-reactive/tree/main/apps/docs) - in the directory `apps/docs`
- Astro website for the library's extensive documentation
1. [landing-page](https://github.com/ayoayco/astro-reactive-library/tree/main/apps/landing-page) - in the directory `apps/landing-page`
1. [landing-page](https://github.com/astro-reactive/astro-reactive/tree/main/apps/landing-page) - in the directory `apps/landing-page`
- Astro website for the library's introductory landing page
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ayoayco/astro-reactive-library.git)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/astro-reactive/astro-reactive.git)
# Running locally
@ -73,10 +76,8 @@ npm start
https://localhost:3000
```
# Applications
We also maintain the documentation website and the project landing page in this repository. The source for these applications is found in the `apps` directory.
You can start the dev server for the docs and landing-page websites with the following commands:
@ -119,13 +120,13 @@ Thank you again for your interest in contributing!
✍️ Read on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/); you'll see this used around issues, PRs, and commit messages
🏘️ Read our [community guidelines](https://github.com/ayoayco/astro-reactive-library/blob/main/CODE_OF_CONDUCT.md)
🏘️ Read our [community guidelines](https://github.com/astro-reactive/astro-reactive/blob/main/CODE_OF_CONDUCT.md)
📝 Check the [discussion board](https://github.com/ayoayco/astro-reactive-library/discussions) for announcements or post your messages and questions
📝 Check the [discussion board](https://github.com/astro-reactive/astro-reactive/discussions) for announcements or post your messages and questions
💬 Hang-out with the team on our [Discord](https://discord.gg/yKyzCjNK) to share feedback, get support, or just have some laughs over memes 😅
🛠️ Create a [new issue](https://github.com/ayoayco/astro-reactive-library/issues/new/choose) for bugs found or improvement ideas
🛠️ Create a [new issue](https://github.com/astro-reactive/astro-reactive/issues/new/choose) for bugs found or improvement ideas
## Play around examples:
@ -141,3 +142,4 @@ Thank you again for your interest in contributing!
alt="CodeSandbox"
/>
</a>

19
README.md
View file

@ -6,13 +6,13 @@
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 href="https://github.com/astro-reactive/astro-reactive/actions/workflows/build-and-test.yml">
<img src="https://github.com/astro-reactive/astro-reactive/actions/workflows/build-and-test.yml/badge.svg?branch=main" alt="Build & Test Result" />
</a>
<a href="https://github.com/ayoayco/astro-reactive-library">
<a href="https://github.com/astro-reactive/astro-reactive">
<img alt="Last Commit" src="https://img.shields.io/github/last-commit/ayoayco/astro-reactive-library?logo=github" />
</a>
<a href="https://gitpod.io/#https://github.com/ayoayco/astro-reactive-library.git">
<a href="https://gitpod.io/#https://github.com/astro-reactive/astro-reactive.git">
<img
src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod"
alt="Contribute with Gitpod"
@ -24,9 +24,9 @@
<p>
| Package | Release notes | Description |
| --- | --- | --- |
| [form](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/form/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](./packages/form/RELEASE.md) | a dynamic form which can be modified programmatically |
| [validator](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](./packages/validator/RELEASE.md) | validators for editable fields |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| [form](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](./packages/form/RELEASE.md) | a dynamic form which can be modified programmatically |
| [validator](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](./packages/validator/RELEASE.md) | validators for editable fields |
| data-grid | 🛠 | a dynamic data grid of values |
| themes | 🛠 | easy-to-use, accessible, consistent cross-browser styles |
| viz | 🛠 | data visualization that emits and responds to events |
@ -87,11 +87,11 @@ npm run landing-page
This project is only possible because of the support and contribution of our community ❤️
<a href="https://github.com/ayoayco/astro-reactive-library/graphs/contributors">
<a href="https://github.com/astro-reactive/astro-reactive/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)_
👉 _[Join our contributors!](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md)_
## Play around examples:
@ -107,3 +107,4 @@ This project is only possible because of the support and contribution of our com
alt="CodeSandbox"
/>
</a>

3
apps/demo/README.md
View file

@ -4,4 +4,5 @@
Start the dev server by running: `npm start`
👉 _[Join our contributors!](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md)_
👉 _[Join our contributors!](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md)_

7
apps/demo/package.json
View file

@ -22,14 +22,15 @@
"main": "index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/ayoayco/astro-reactive-library.git"
"url": "git+https://github.com/astro-reactive/astro-reactive.git"
},
"license": "ISC",
"bugs": {
"url": "https://github.com/ayoayco/astro-reactive-library/issues"
"url": "https://github.com/astro-reactive/astro-reactive/issues"
},
"homepage": "https://github.com/ayoayco/astro-reactive-library#readme",
"homepage": "https://github.com/astro-reactive/astro-reactive#readme",
"devDependencies": {
"rimraf": "^3.0.2"
}
}

3
apps/docs/README.md
View file

@ -4,4 +4,5 @@
Start the dev server by running: `npm run docs`
👉 _[Join our contributors!](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md)_
👉 _[Join our contributors!](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md)_

7
apps/docs/package.json
View file

@ -32,15 +32,16 @@
"main": "index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/ayoayco/astro-reactive-library.git"
"url": "git+https://github.com/astro-reactive/astro-reactive.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/ayoayco/astro-reactive-library/issues"
"url": "https://github.com/astro-reactive/astro-reactive/issues"
},
"homepage": "https://github.com/ayoayco/astro-reactive-library#readme",
"homepage": "https://github.com/astro-reactive/astro-reactive#readme",
"devDependencies": {
"rimraf": "^3.0.2"
}
}

3
apps/docs/src/components/Footer/AvatarList.astro
View file

@ -6,7 +6,7 @@ type Props = {
const { path } = Astro.props as Props;
const resolvedPath = `apps/docs/${path}`;
const url = `https://api.github.com/repos/ayoayco/astro-reactive-library/commits?path=${resolvedPath}`;
const commitsURL = `https://github.com/ayoayco/astro-reactive-library/commits/main/${resolvedPath}`;
const commitsURL = `https://github.com/astro-reactive/astro-reactive/commits/main/${resolvedPath}`;
type Commit = {
author: {
@ -180,3 +180,4 @@ const additionalContributors = unique.length - recentContributors.length; // lis
margin-left: 0.75rem;
}
</style>

5
apps/docs/src/config.ts
View file

@ -7,7 +7,7 @@ export const SITE = {
export const OPEN_GRAPH = {
image: {
src: "https://github.com/ayoayco/astro-reactive-library/blob/main/.github/assets/astro-reactive-library-cover.png?raw=true",
src: "https://github.com/astro-reactive/astro-reactive/blob/main/.github/assets/astro-reactive-library-cover.png?raw=true",
alt: "astro logo and astro reactive library text on a starry expanse of space",
},
twitter: "astroreactive",
@ -29,7 +29,7 @@ export const KNOWN_LANGUAGES = {
} as const;
export const KNOWN_LANGUAGE_CODES = Object.values(KNOWN_LANGUAGES);
export const GITHUB_EDIT_URL = `https://github.com/ayoayco/astro-reactive-library/tree/main/apps/docs`;
export const GITHUB_EDIT_URL = `https://github.com/astro-reactive/astro-reactive/tree/main/apps/docs`;
export const COMMUNITY_INVITE_URL = `https://discord.gg/yKyzCjNK`;
@ -67,3 +67,4 @@ export const SIDEBAR: Sidebar = {
],
},
};

3
apps/docs/src/layouts/MainLayout.astro
View file

@ -145,7 +145,7 @@ const githubEditUrl = `${CONFIG.GITHUB_EDIT_URL}/${currentFile}`;
<div class="warning">
<strong>🛠 Under Construction:</strong> This library and the documentation
are undergoing rigorous development. Read and join our <a
href="https://github.com/ayoayco/astro-reactive-library/discussions"
href="https://github.com/astro-reactive/astro-reactive/discussions"
>discussions</a
> for questions, suggestions, or feedback.
</div>
@ -164,3 +164,4 @@ const githubEditUrl = `${CONFIG.GITHUB_EDIT_URL}/${currentFile}`;
<Footer path={currentFile} />
</body>
</html>

3
apps/docs/src/pages/en/api/form/form-component.md
View file

@ -152,7 +152,7 @@ const submitControl: Submit = {
<Form formGroups={form} submitControl={submitControl} />
```
This is a very crude solution to prevent having multiple submit buttons. For suggestions to improve this, join our [discussions](https://github.com/ayoayco/astro-reactive-library/discussions).
This is a very crude solution to prevent having multiple submit buttons. For suggestions to improve this, join our [discussions](https://github.com/astro-reactive/astro-reactive/discussions).
---
@ -203,3 +203,4 @@ Type: `Submit`
### `theme`
Type: `'light' | 'dark'`

13
apps/docs/src/pages/en/introduction.md
View file

@ -18,11 +18,11 @@ We are in pursuit of an easy developer experience for implementing reactive UIs
This will be released as a core package of the library to support reactivity across our packages, and hopefully as a utility to use for your own components.
As of now this is still a *goal*. In other words, we see this as researching the [hyperdrive](https://starwars.fandom.com/wiki/Hyperdrive/Legends) engine to explore new frontiers with Astro.
As of now this is still a _goal_. In other words, we see this as researching the [hyperdrive](https://starwars.fandom.com/wiki/Hyperdrive/Legends) engine to explore new frontiers with Astro.
And we're having fun.
*👉 [Join us!](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md#readme)*
_👉 [Join us!](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md#readme)_
## Project Motivation
@ -34,7 +34,7 @@ However we also see that Astro has given us a good baseline framework to potenti
The challenge right now is that there is no opinionated way to "resume" what your components did from the server to the browser. So I thought: What if there is a library of components and utilities to help us do this?
In this project, our motivation is to get to this future. This is our *next frontier 🚀*
In this project, our motivation is to get to this future. This is our _next frontier 🚀_
## Some Tradeoffs
@ -49,9 +49,10 @@ We will also make this clear in our library documentation as we see them.
## Packages
| Package | Release notes | Description |
| --- | --- | --- |
| [form](/en/api/form/form-component) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](./packages/form/RELEASE.md) | a dynamic form which can be modified programmatically |
| [validator](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](./packages/validator/RELEASE.md) | validators for editable fields |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| [form](/en/api/form/form-component) | [![npm](https://img.shields.io/npm/v/@astro-reactive/form)](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/RELEASE.md) | a dynamic form which can be modified programmatically |
| [validator](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md) | [![npm](https://img.shields.io/npm/v/@astro-reactive/validator)](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/RELEASE.md) | validators for editable fields |
| data-grid | 🛠 | a dynamic data grid of values |
| themes | 🛠 | easy-to-use, accessible, consistent cross-browser styles |
| viz | 🛠 | data visualization that emits and responds to events |

5
apps/docs/src/pages/en/tutorial/page-2.md
View file

@ -17,9 +17,10 @@ Generate a dynamic form based on your data, and modify programatically.
The Reactive Form component for [Astro](https://astro.build) 🔥
_[All contributions are welcome.](https://github.com/ayoayco/astro-reactive-library/issues)_
_[All contributions are welcome.](https://github.com/astro-reactive/astro-reactive/issues)_
## Installation
In your Astro project:
```
@ -27,6 +28,7 @@ npm i @astro-reactive/form
```
## Usage
Use in an Astro page:
```astro
@ -103,3 +105,4 @@ Currently this only supports very basic form creation, but the goal of the proje
... and so much more
_All contributions are welcome. Let's make the fastest web form component powered by Astro_

2
apps/landing-page/README.md
View file

@ -4,4 +4,4 @@
Start the dev server by running: `npm run landing-page`
👉 _[Join our contributors!](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md)_
👉 _[Join our contributors!](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md)_

7
apps/landing-page/package.json
View file

@ -31,12 +31,13 @@
"main": "index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/ayoayco/astro-reactive-library.git"
"url": "git+https://github.com/astro-reactive/astro-reactive.git"
},
"author": "Ayo Ayco",
"license": "MIT",
"bugs": {
"url": "https://github.com/ayoayco/astro-reactive-library/issues"
"url": "https://github.com/astro-reactive/astro-reactive/issues"
},
"homepage": "https://github.com/ayoayco/astro-reactive-library#readme"
"homepage": "https://github.com/astro-reactive/astro-reactive#readme"
}

3
apps/landing-page/src/components/header.astro
View file

@ -5,7 +5,7 @@ import { Icon } from "astro-icon";
const socials = [
{
name: "GitHub",
url: "https://github.com/ayoayco/astro-reactive-library",
url: "https://github.com/astro-reactive/astro-reactive",
icon: "fa-brands:github-alt",
},
{
@ -122,3 +122,4 @@ const socials = [
@apply block;
}
</style>

6
package-lock.json generated
View file

@ -8495,7 +8495,7 @@
},
"packages/common": {
"name": "@astro-reactive/common",
"version": "0.1.3",
"version": "0.1.4",
"license": "MIT",
"devDependencies": {
"rimraf": "^3.0.2"
@ -8503,7 +8503,7 @@
},
"packages/form": {
"name": "@astro-reactive/form",
"version": "0.6.5",
"version": "0.6.6",
"license": "MIT",
"dependencies": {
"@astro-reactive/common": "*",
@ -8533,7 +8533,7 @@
},
"packages/validator": {
"name": "@astro-reactive/validator",
"version": "0.2.5",
"version": "0.2.6",
"license": "MIT",
"dependencies": {
"@astro-reactive/common": "*"

3
package.json
View file

@ -2,7 +2,7 @@
"name": "astro-reactive-library",
"description": "Astro components for building reactive user interfaces 🚀",
"version": "0.0.0",
"repository": "https://github.com/ayoayco/astro-reactive-library",
"repository": "https://github.com/astro-reactive/astro-reactive",
"homepage": "https://ayco.io/showcase/astro-reactive-library#readme",
"author": {
"name": "Ayo Ayco",
@ -47,3 +47,4 @@
"turbo": "^1.6.3"
}
}

7
packages/common/package.json
View file

@ -20,15 +20,16 @@
],
"repository": {
"type": "git",
"url": "git+https://github.com/ayoayco/astro-reactive-library.git"
"url": "git+https://github.com/astro-reactive/astro-reactive.git"
},
"author": "Ayo Ayco",
"license": "MIT",
"bugs": {
"url": "https://github.com/ayoayco/astro-reactive-library/issues"
"url": "https://github.com/astro-reactive/astro-reactive/issues"
},
"homepage": "https://github.com/ayoayco/astro-reactive-library#readme",
"homepage": "https://github.com/astro-reactive/astro-reactive#readme",
"publishConfig": {
"access": "public"
}
}

5
packages/form/README.md
View file

@ -99,6 +99,7 @@ This Form component is designed to work with [Astro Reactive Validator](https://
# We are opensource!
👉 _All [contributions](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md) are welcome. Let's make the fastest web forms powered by Astro._
👉 _All [contributions](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md) are welcome. Let's make the fastest web forms powered by Astro._
👉 _This package is under rigorous development. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/form/RELEASE.md)._
👉 _This package is under rigorous development. See the [change log](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/form/RELEASE.md)._

3
packages/form/package.json
View file

@ -2,7 +2,7 @@
"name": "@astro-reactive/form",
"description": "The Reactive Form component for Astro 🔥",
"version": "0.6.6",
"repository": "https://github.com/ayoayco/astro-reactive-library",
"repository": "https://github.com/astro-reactive/astro-reactive",
"homepage": "https://docs.astro-reactive.dev/en/api/form/form-component/",
"author": {
"name": "Ayo Ayco",
@ -62,3 +62,4 @@
"access": "public"
}
}

5
packages/validator/README.md
View file

@ -99,6 +99,7 @@ This validation library is designed to work with [Astro Reactive Form](https://w
# We are opensource!
👉 _All [contributions](https://github.com/ayoayco/astro-reactive-library/blob/main/CONTRIBUTING.md) are welcome. Let's make the validation library for Astro._
👉 _All [contributions](https://github.com/astro-reactive/astro-reactive/blob/main/CONTRIBUTING.md) are welcome. Let's make the validation library for Astro._
👉 _This package is under rigorous development. See the [change log](https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/RELEASE.md)_.
👉 _This package is under rigorous development. See the [change log](https://github.com/ayoayco/astro-reactive-library/blob/main/packages/validator/RELEASE.md)_.

7
packages/validator/package.json
View file

@ -2,8 +2,8 @@
"name": "@astro-reactive/validator",
"description": "Form validation library for Astro 🔥",
"version": "0.2.6",
"repository": "https://github.com/ayoayco/astro-reactive-library",
"homepage": "https://github.com/ayoayco/astro-reactive-library/blob/main/packages/validator/README.md",
"repository": "https://github.com/astro-reactive/astro-reactive",
"homepage": "https://github.com/astro-reactive/astro-reactive/blob/main/packages/validator/README.md",
"author": {
"name": "Ayo Ayco",
"email": "ayo@ayco.io",
@ -59,9 +59,10 @@
},
"license": "MIT",
"bugs": {
"url": "https://github.com/ayoayco/astro-reactive-library/issues"
"url": "https://github.com/astro-reactive/astro-reactive/issues"
},
"publishConfig": {
"access": "public"
}
}