Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDU-5360] refactor: update and standardize Templates readMes #164

Merged
merged 77 commits into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
4780f48
refactor: readme 11ty Landing Page
MarianaAguilera Oct 22, 2024
5fa2361
refactor: update readme - 11ty link un bio
MarianaAguilera Oct 22, 2024
c19a959
refactor: update readme - 11ty micro site
MarianaAguilera Oct 22, 2024
1434929
refactor: update readme - 11ty photo gallery
MarianaAguilera Oct 22, 2024
e7e2696
refactor: update readme - 11ty portfolio
MarianaAguilera Oct 22, 2024
06f992a
refactor: update readme - 11ty shop
MarianaAguilera Oct 22, 2024
d7b847c
refactor: update readme - 11ty Starter Kit
MarianaAguilera Oct 22, 2024
d6ba450
refactor: update readme - Mobile11ty
MarianaAguilera Oct 22, 2024
13011a4
refactor: update readme - Eleventy 2 Snipcart
MarianaAguilera Oct 22, 2024
5d6834c
refactor: update readme - Eleventy and Snipcart for eCommerce
MarianaAguilera Oct 22, 2024
d5a5b8c
refactor: update readme - 11ty Base Blog
MarianaAguilera Oct 22, 2024
bac388c
Update README.md
MarianaAguilera Oct 22, 2024
556d462
refactor: update readme - Vue3/Vite
MarianaAguilera Oct 23, 2024
e95e632
refactor: update readme - Vue Boilerplate
MarianaAguilera Oct 23, 2024
88dadc8
refactor: update readme - Vitepress JS + TS
MarianaAguilera Oct 23, 2024
a79e89f
refactor: update readme - Svelte
MarianaAguilera Oct 23, 2024
2968256
refactor: update readme - Book Store React
MarianaAguilera Oct 23, 2024
d349342
refactor: update readme - React Boilerplate
MarianaAguilera Oct 23, 2024
1a61bcb
refactor: update readme - Jekyll boilerplate
MarianaAguilera Oct 23, 2024
29f5f35
refactor: update readme - jekyll cart
MarianaAguilera Oct 23, 2024
aea1ea8
refactor: update readme - Jekyll suply
MarianaAguilera Oct 23, 2024
ac478d2
refactor: update readme - Angular boilerplate
MarianaAguilera Oct 23, 2024
16752dd
refactor: update readme - Hugo Boilerplate
MarianaAguilera Oct 23, 2024
46fe563
refactor: update readme - Influencer + Vex Hugo
MarianaAguilera Oct 23, 2024
d28e2c7
refactor: update readme - hexo boilerplate
MarianaAguilera Oct 23, 2024
dea31e6
refactor: update readmes - Docusaurus JS, TS and Material
MarianaAguilera Oct 24, 2024
3505c99
refactor: uppdate readme - mongodb atlas
MarianaAguilera Oct 24, 2024
bc94ed3
refactor: update readme - Gastby Boilerplate, Blog, Ecommerce
MarianaAguilera Oct 24, 2024
280c660
refactor: update Azion Edge SQL
MarianaAguilera Oct 25, 2024
dd77a59
refactor: update readme - Edge Function GitHub AutoDeploy
MarianaAguilera Oct 25, 2024
77a024b
refactor: update readme - Fauna DB
MarianaAguilera Oct 25, 2024
91c049b
refactor: update readme - Hello World
MarianaAguilera Oct 25, 2024
12b0cc7
refactor: update readme - HTMX
MarianaAguilera Oct 25, 2024
e14fe52
refactor: update readme - QStash EdgeFunction Scheduler
MarianaAguilera Oct 25, 2024
99535cd
refactor: update readme - Turso Starter Kit
MarianaAguilera Oct 25, 2024
bd650e4
refactor: update readme - Upstash GeoLocation
MarianaAguilera Oct 25, 2024
489ec5a
refactor: update readme - Upstash Rate Limit
MarianaAguilera Oct 25, 2024
8720a10
refactor: update readme - Ecommerce Stationery NextJs
MarianaAguilera Oct 28, 2024
3a553bf
refactor: update readme - Kupingplug
MarianaAguilera Oct 28, 2024
8aa8927
refactor: update readme - Next.js App + Configurations
MarianaAguilera Oct 28, 2024
f63fb0f
refactor: update readme - Next.js App + Middleware
MarianaAguilera Oct 28, 2024
346ae77
refactor: update readme - Next.js Pages + Configurations
MarianaAguilera Oct 28, 2024
e51f245
refactor: update readme - Next.js Pages + Middleware
MarianaAguilera Oct 28, 2024
b9e8c26
refactor: update readme - next static 13
MarianaAguilera Oct 28, 2024
24fe243
refactor: update readme - Next 14 Boilerplate
MarianaAguilera Oct 28, 2024
76f286a
refactor: update readme - NextJs Store Ecommerce
MarianaAguilera Oct 28, 2024
777a222
refactor: update readme - Simple Ecommerce Nextjs
MarianaAguilera Oct 28, 2024
de12978
refactor: update readme - Space Jelly Shop
MarianaAguilera Oct 28, 2024
da8d42e
refactor: update readme - Astro Audiophile
MarianaAguilera Oct 29, 2024
8bcd3e7
refactor: update readme - Astro Blog Starter Kit
MarianaAguilera Oct 29, 2024
1d88210
refactor: update readme - Astro Boilerplate
MarianaAguilera Oct 29, 2024
87413b5
refactor: update readme - Astro Ecommerce
MarianaAguilera Oct 29, 2024
a52b534
refactor: update readme - Astro with Framework Alpine
MarianaAguilera Oct 29, 2024
ffb8c71
refactor: update readme - Astro with Framework Lit
MarianaAguilera Oct 29, 2024
26b41b4
refactor: update readme - Astro with Multiple Frameworks
MarianaAguilera Oct 29, 2024
9b185dd
refactor: update readme - Astro with Framework Preact
MarianaAguilera Oct 29, 2024
cdea214
refactor: update readme - Astro with Framework React
MarianaAguilera Oct 29, 2024
2a12da4
refactor: update readme - Astro with Framework Solid
MarianaAguilera Oct 29, 2024
9025f6a
refactor: update readme - Astro with Framework Svelte
MarianaAguilera Oct 29, 2024
8969e15
refactor: update readme - Astro with Framework Vue
MarianaAguilera Oct 29, 2024
cdc0ed2
refactor: update readme - Astro Minimal
MarianaAguilera Oct 29, 2024
46c2070
refactor: update readme - Astro with Non-HTML Pages
MarianaAguilera Oct 29, 2024
a776f9c
refactor: update readme - Astro Portfolio
MarianaAguilera Oct 29, 2024
3d5565c
refactor: update readme - Astro Quickstore
MarianaAguilera Oct 29, 2024
0d743f1
refactor: update readme - Astro Starlog
MarianaAguilera Oct 29, 2024
af0bb11
refactor: update readme - Astro with Markdoc
MarianaAguilera Oct 29, 2024
504eb17
refactor: update readme - Astro Markdown with plugins
MarianaAguilera Oct 29, 2024
17192f0
refactor: update readme - Astro Markdown with Shiki
MarianaAguilera Oct 29, 2024
74e6531
refactor: update readme - Astro with MDX
MarianaAguilera Oct 29, 2024
acc7ff7
Update README.md
MarianaAguilera Oct 29, 2024
9298a44
Update README.md
MarianaAguilera Oct 29, 2024
b32130b
refactor: update readme - Astro with Nano Stores
MarianaAguilera Oct 29, 2024
5bd5940
refactor: update readme - Astro with Tailwind CSS
MarianaAguilera Oct 29, 2024
1be1e44
refactor: update readme - Astro with Vitest
MarianaAguilera Oct 29, 2024
babc306
refactor: update readmes - devscard & web to pdf
MarianaAguilera Oct 29, 2024
280982c
Merge branch 'dev' into edu-5360-review-readmes-templates
MarianaAguilera Oct 30, 2024
86493e7
refactor: add videos links
MarianaAguilera Oct 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 12 additions & 61 deletions templates/angular/angular-boilerplate/README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,28 @@
# Angular Boilerplate

The **Angular Boilerplate** is designed to simplify and enhance the deployment process for Angular.js applications directly on the edge of the network.
With the **Angular Boilerplate**, you can simplify and enhance the deployment of Angular applications directly on the edge of the network. This template provides an automation solution that encapsulates several steps, from repository management to edge deployment, accelerating and simplifying your workflow.

This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template via Azion Real-Time Manager (RTM), check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide.
This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide.

This template uses Angular CLI version `16.1.3`.
This template uses Angular CLI version `16.2.0`.

---

## Deploy Your Own
## Requirements

Deploy your own Angular project with Azion.

[![Deploy Button](/static/button.png)](https://console.azion.com/create/angular/angular-boilerplate "Deploy with Azion")

---

## Usage information

To use this template, you must [sign in on Azion Console](https://console.azion.com/login).

> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration.

To successfully deploy this template, you need to provide the information to configure your Azion application, as requested in the **Settings** tab on the template's page.

For a more detailed step-by-step on using this template and requirements, check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide.

### Requirements

- Generate a [GitHub personal token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
- Enable [Edge Functions](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) on your Azion account.

---

## Continuous deployment

Once the template is deployed, you can edit and update your args and code, as well as implement a continuous deployment workflow. However, you'll need first to *declare secrets on your project's GitHub repository* to complete the second build with the changes. When the second build is completed, you'll be able to manage your project with a continuous deployment workflow and edit the args as desired.

To do so, open your repository in GitHub. Then, go to **Settings** > **Secrets and variables** > **Action** to [add your variables](https://docs.github.com/en/actions/security-guides/encrypted-secrets), following these instructions:

1. Add the Azion personal token to the *secrets*:
- Read [how to generate an Azion personal token](https://www.azion.com/en/documentation/products/accounts/personal-tokens/) in the documentation.

```bash
AZION_PERSONAL_TOKEN=<value>
```

2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository:
Before using this template, you need to:

```yml
- name: edge-...
id: azion_edge
...
with:
....
azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }}
....
- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

```

3. Open a pull request to merge the changes to the main branch and start the automatic deployment.

Now your project is ready to work with a continuous deployment workflow, updating instantly any changes in the application or the repository.
> **Note**: this template uses [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

---

## Management

Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using [Azion Console](https://console.azion.com/).
## Deploy your own

To manage and edit your edge application’s settings, read the documentation about [managing edge applications](https://www.azion.com/en/documentation/products/edge-application/first-steps/) for more details.

### Custom domain
Deploy your own Angular project with Azion.

The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net`. However, you can add a custom domain for users to access your edge application through it. Go to the [Domains](https://www.azion.com/en/documentation/products/guides/configure-a-domain/) documentation to read more about it.
[![Deploy Button](/static/button.png)](https://console.azion.com/create/angular/angular-boilerplate "Deploy with Azion")

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/).
63 changes: 22 additions & 41 deletions templates/astro/astro-audiophile/README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,32 @@
# Astro-commerce
# Astro Audiophile

An ecommerce template for small bussiness. Although this template showcases a store for audio devices, it could be used showcase any type of product.
The **Astro Audiophile** template provides a quick option to create an e-commerce website based on the Astro framework. Even when the default visual is designed as a store or catalog for audio devices, it can be customized to showcase any type of product.

This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/).

This template uses Astro version `3.1.2`.

> **Note**: this is a community template. Third-party or external developers created it, and Azion only enables the deployment in the Azion Edge Platform. Azion doesn't provide maintenance or support for the content itself but can assist you with any queries or issues you may encounter while deploying this template or using the platform.
>
> Join the Azion communities at [GitHub](https://github.com/aziontech) and [Discord](https://discord.com/channels/1112754829878624390/1113104727979348008) to learn, seek advice, and stay updated on trends.

---

## Deploy Your Own
## Requirements

Deploy your own Astro Audiophile project with Azion.
Before using this template, you need to:

[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/astro-audiophile "Deploy with Azion")
- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/),[Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

---

## 🚀 Project Structure

The project follows the atomic design structure [Learn more](https://bradfrost.com/blog/post/atomic-web-design/)

Inside of this project, you'll see the following folders and files. They make up the main parts of the project.

```text

├── public/
│ ├── assets/
│ │ └── All images used.
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── atoms
│ │ ├── molecules
│ │ ├── organisms
│ ├── design-system/
│ ├── layouts/
│ ├── pages/
│ └── utils/
└── package.json
```

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## Deploy your own

Deploy your own Astro Audiophile project with Azion.

[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/astro-audiophile "Deploy with Azion")

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/).
64 changes: 9 additions & 55 deletions templates/astro/astro-blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,69 +6,23 @@ This repository is an example of the new GitHub repository created during the de

This template uses Astro version `4.2.6`.


## Deploy Your Own

Deploy your own Astro project with Azion.

[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-blog-starter-kit "Deploy with Azion")


## Usage information

To use this template, you must [sign in on Azion Console](https://console.azion.com/login).

> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration.

To successfully deploy this template, you need to provide the information to configure your Azion application, as requested in the **Settings** tab on the template's page.

For a more detailed step-by-step on using this template and requirements, check the [How to deploy an Astro blog using a template](https://www.azion.com/en/documentation/products/guides/astro-blog-starter-kit/) guide.

### Requirements

- Generate your [GitHub personal token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
- Enable [Edge Functions and Image Processor](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account.

---

## Continuous deployment

Once the template is deployed, you can edit and update your args and code, as well as implement a continuous deployment workflow. However, you'll need first to *declare secrets on your project's GitHub repository* to complete the second build with the changes. When the second build is completed, you'll be able to manage your project with a continuous deployment workflow and edit the args as desired.

To do so, open your repository in GitHub. Then, go to **Settings** > **Secrets and variables** > **Action** to [add your variables](https://docs.github.com/en/actions/security-guides/encrypted-secrets), following these instructions:

1. Add the Azion personal token to the *secrets*:
- Read [how to generate an Azion personal token](https://www.azion.com/en/documentation/products/guides/personal-tokens/) in the documentation.

```bash
AZION_PERSONAL_TOKEN=<value>
```
## Requirements

2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository:
Before using this template, you need to:

```yml
- name: edge-...
id: azion_edge
...
with:
....
azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }}
....
- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

```

3. Open a pull request to merge the changes to the main branch and start the automatic deployment.

Now your project is ready to work with a continuous deployment workflow, updating instantly any changes in the application or the repository.
> **Note**: this template uses [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/) and [Image Processor](https://www.azion.com/en/documentation/products/build/edge-application/image-processor/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

---

## Management

Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using [Azion Console)](https://console.azion.com/).
## Deploy your own

To manage and edit your edge application’s settings, read the documentation about [managing edge applications](https://www.azion.com/en/documentation/products/edge-application/first-steps/) for more details.
Deploy your own Astro project with Azion.

### Custom domain
[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-blog-starter-kit "Deploy with Azion")

The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net`. However, you can add a custom domain for users to access your edge application through it. Go to the [Domains](https://www.azion.com/en/documentation/products/guides/configure-a-domain/) documentation to read more about it.
For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-blog-starter-kit/).
71 changes: 10 additions & 61 deletions templates/astro/astro-boilerplate/README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,28 @@
# Astro Boilerplate

The **Astro Boilerplate** is designed to simplify and enhance the deployment process for Astro applications directly on the edge of the network.
The **Astro Boilerplate** provides an automation solution to simplify and enhance the deployment of Astro applications directly on the edge of the network. By using this boilerplate, you can accelerate your workflow for building user interfaces and web applications.

This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template, check the [How to deploy edge applications with the Astro Boilerplate](https://www.azion.com/en/documentation/products/guides/astro-boilerplate/) guide.

This template uses Astro version `4.5.12`.


---

## Deploy Your Own

Deploy your own Astro project with Azion.

[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-boilerplate "Deploy with Azion")


---

## Usage information

To use this template, you must [sign in on Azion Console](https://console.azion.com/login).

> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration.

To successfully deploy this template, you need to provide the information to configure your Azion application, as requested in the **Settings** tab on the template's page.

For a more detailed step-by-step on using this template and requirements, check the [How to deploy edge applications with the Astro Boilerplate](https://www.azion.com/en/documentation/products/guides/astro-boilerplate/) guide.

### Requirements

- Generate your [GitHub personal token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
- Enable [Edge Functions](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account.

---

## Continuous deployment

Once the template is deployed, you can edit and update your args and code, as well as implement a continuous deployment workflow. However, you'll need first to *declare secrets on your project's GitHub repository* to complete the second build with the changes. When the second build is completed, you'll be able to manage your project with a continuous deployment workflow and edit the args as desired.

To do so, open your repository in GitHub. Then, go to **Settings** > **Secrets and variables** > **Action** to [add your variables](https://docs.github.com/en/actions/security-guides/encrypted-secrets), following these instructions:

1. Add the Azion personal token to the *secrets*:
- Read [how to generate an Azion personal token](https://www.azion.com/en/documentation/products/guides/personal-tokens/) in the documentation.
## Requirements

```bash
AZION_PERSONAL_TOKEN=<value>
```
Before using this template, you need to:

2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository:
- Have a [GitHub account](https://github.com/signup).
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.

```yml
- name: edge-...
id: azion_edge
...
with:
....
azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }}
....

```

3. Open a pull request to merge the changes to the main branch and start the automatic deployment.

Now your project is ready to work with a continuous deployment workflow, updating instantly any changes in the application or the repository.
> **Note**: this template uses [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.

---

## Management

Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using [Azion Console)](https://console.azion.com/).
## Deploy your own

To manage and edit your edge application’s settings, read the documentation about [managing edge applications](https://www.azion.com/en/documentation/products/edge-application/first-steps/) for more details.

### Custom domain
Deploy your own Astro project with Azion.

The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net`. However, you can add a custom domain for users to access your edge application through it. Go to the [Domains](https://www.azion.com/en/documentation/products/guides/configure-a-domain/) documentation to read more about it.
[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-boilerplate "Deploy with Azion")

For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-boilerplate/).
Loading
Loading