diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d8c95f..90df446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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,20 +27,22 @@ 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` - - 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` - - 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` - - 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` - - 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` - - 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) +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/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/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/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/astro-reactive/astro-reactive/tree/main/apps/landing-page) - in the directory `apps/landing-page` -# Running locally + - 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/astro-reactive/astro-reactive.git) + +# Running locally We mainly use the `demo` app to see changes we make on the packages. Do the following to start hacking: @@ -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" /> + diff --git a/README.md b/README.md index 35e5f01..b8f5c8d 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ Let your data build your UI with native Astro components and architecture.

- - Build & Test Result + + Build & Test Result - + Last Commit - + Contribute with Gitpod

-| 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 | -| 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 | +| Package | Release notes | Description | +| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| [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 | # Running locally @@ -87,11 +87,11 @@ npm run landing-page This project is only possible because of the support and contribution of our community ❤️ - + -👉 _[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" /> + diff --git a/apps/demo/README.md b/apps/demo/README.md index ead0266..0e23d61 100644 --- a/apps/demo/README.md +++ b/apps/demo/README.md @@ -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)_ + diff --git a/apps/demo/package.json b/apps/demo/package.json index 946a783..a698bd5 100644 --- a/apps/demo/package.json +++ b/apps/demo/package.json @@ -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" } } + diff --git a/apps/docs/README.md b/apps/docs/README.md index d29425a..ebfb651 100644 --- a/apps/docs/README.md +++ b/apps/docs/README.md @@ -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)_ + diff --git a/apps/docs/package.json b/apps/docs/package.json index 4ab5e30..fb43db1 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -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" } } + diff --git a/apps/docs/src/components/Footer/AvatarList.astro b/apps/docs/src/components/Footer/AvatarList.astro index c8fe863..f6b0d87 100644 --- a/apps/docs/src/components/Footer/AvatarList.astro +++ b/apps/docs/src/components/Footer/AvatarList.astro @@ -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; } + diff --git a/apps/docs/src/config.ts b/apps/docs/src/config.ts index cdd3f08..5c26adc 100644 --- a/apps/docs/src/config.ts +++ b/apps/docs/src/config.ts @@ -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 = { ], }, }; + diff --git a/apps/docs/src/layouts/MainLayout.astro b/apps/docs/src/layouts/MainLayout.astro index 1688fc6..d9bb4bd 100644 --- a/apps/docs/src/layouts/MainLayout.astro +++ b/apps/docs/src/layouts/MainLayout.astro @@ -145,7 +145,7 @@ const githubEditUrl = `${CONFIG.GITHUB_EDIT_URL}/${currentFile}`;

🛠 Under Construction: This library and the documentation are undergoing rigorous development. Read and join our discussions for questions, suggestions, or feedback.
@@ -164,3 +164,4 @@ const githubEditUrl = `${CONFIG.GITHUB_EDIT_URL}/${currentFile}`;