From 4780f48f04d28dfdc0c0407e5f500db8c0792a84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 10:58:33 -0300 Subject: [PATCH 01/76] refactor: readme 11ty Landing Page --- .../eleventy-11ty-landing-page/README.md | 63 ++++++------------- 1 file changed, 18 insertions(+), 45 deletions(-) diff --git a/templates/eleventy/eleventy-11ty-landing-page/README.md b/templates/eleventy/eleventy-11ty-landing-page/README.md index cfbd9198..1cba2f16 100644 --- a/templates/eleventy/eleventy-11ty-landing-page/README.md +++ b/templates/eleventy/eleventy-11ty-landing-page/README.md @@ -1,59 +1,32 @@ -# 11ty-landing-page +# 11ty Landing Page -A simple landing page built with 11ty and Tailwind CSS. +The **11ty Landing Page** template helps you to build a simple landing page with 11ty and Tailwind CSS. -## Deploy Your Own - -Deploy your own 11ty project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-landing-page "Deploy with Azion") - - -## How to use this template - -**Requirements:** +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/use-a-template-via-azion-console/). -1. Eleventy (developed and tested with version 0.12.1) -2. Tailwind CSS +This template uses Eleventy version `0.12.1` and TailwindCSS `2.0.4`. -All other dependencies are either linked from a CDN or included in this repository. +> **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. -**Setup:** +--- -1. Fork, clone or download -2. `cd` into the root folder -3. run `npm install` -4. run `npm run serve` -5. open a browser and go to `http://localhost:8080` +## Requirements -**Basic configuration:** +Before using this template, you need to: -1. Eleventy -> `./.eleventy.js` -2. Tailwind -> `./tailwind.config.js` -3. Netlify -> `./netlify.toml` +- 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. -CSS is built via PostCSS and based on `./src/_includes/css/_page.css`. Building CSS gets triggered by `./src/css/page.11ty.js` and Tailwind's config is set to JIT (see: [Tailwind docs](https://tailwindcss.com/docs/just-in-time-mode)) +**Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -Please note that this CSS build _does not_ include the `normalize.css` file used for the 2 regular pages (imprint, privacy) - a minified production version is stored in `./src/static/css` and gets included in the build by default. +--- -**Change Content:** - -Page content is stored in - -- `./src/` - - `imprint.md` - - `privacy.md` -- `./src/sections/` -- `./src/_data/features.json` - -**Change Templates/Layout:** - -Page structure and templates are stored in `./src/_layouts/` and can be edited there. - -Best have a look at `./layouts/base.njk` first to understand how it all comes together - the page itself is constructed from partial templates stored in `./src/includes/` and each section has a corresponding template file (`section.**.njk`) stored there. +## Deploy Your Own -`index.njk` in `./src/` arranges everything, meaning that sections can be added/re-ordered/removed/... there. +Deploy your own 11ty project with Azion. -**Change images:** +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-landing-page "Deploy with Azion") -Images are stored in `./static/img/`; everything in there can be considered a placeholder that should eventually be replaced with your actual production images. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 5fa236195863297db1eb989558fc726bd19fedf3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 14:45:54 -0300 Subject: [PATCH 02/76] refactor: update readme - 11ty link un bio --- .../eleventy-11ty-landing-page/README.md | 4 +- .../eleventy-link-in-bio-11ty/README.md | 39 +++++++++++-------- 2 files changed, 25 insertions(+), 18 deletions(-) diff --git a/templates/eleventy/eleventy-11ty-landing-page/README.md b/templates/eleventy/eleventy-11ty-landing-page/README.md index 1cba2f16..cb932f0a 100644 --- a/templates/eleventy/eleventy-11ty-landing-page/README.md +++ b/templates/eleventy/eleventy-11ty-landing-page/README.md @@ -19,11 +19,11 @@ Before using this template, you need to: - 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/) and [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. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. --- -## Deploy Your Own +## Deploy your own Deploy your own 11ty project with Azion. diff --git a/templates/eleventy/eleventy-link-in-bio-11ty/README.md b/templates/eleventy/eleventy-link-in-bio-11ty/README.md index a1b46875..50c2710d 100644 --- a/templates/eleventy/eleventy-link-in-bio-11ty/README.md +++ b/templates/eleventy/eleventy-link-in-bio-11ty/README.md @@ -1,25 +1,32 @@ -# link-in-bio-11ty +# 11ty Link in Bio -`link-in-bio-11ty` was built off of a starter template for the [11ty](https://11ty.io) static site generator on [glitch.com](https://glitch.com). That template was [~11ty](https://glitch.com/~11ty) which [Cassey](https://glitch.com/@cassey) made [some slight modifications to](https://glitch.com/~11ty-simple) for better running on Glitch. The primary change there was to disable browsersync syncing. +The **11ty Link in Bio** template accelerates the creation of a list of links, built with 11ty. -See [the project live](https://qk48ihj1x4.map.azionedge.net). +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/use-a-template-via-azion-console/). -## Deploy Your Own +This template uses Eleventy version `0.9.0`. See [the project live](https://qk48ihj1x4.map.azionedge.net). -Deploy your own 11ty project with Azion. +> **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 Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-link-in-bio "Deploy with Azion") +--- + +## Requirements + +Before using this template, you need to: + +- 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. -## How to use this app -1. [Remix this project on Glitch](https://glitch.com/~link-in-bio-11ty) or clone the repository. -2. If you're on Glitch: Rename the project by clicking the project name in the top left corner of the tab, if you desire. -3. Customize this site by modifying `src/_data/siteData.json` and adding your links in `src/_data/links.js`. -4. Customize the CSS as you wish - especially the colors. -5. Share with your friends! +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. +--- -## I'm on Glitch - what if it breaks? -The live refreshing nature of Glitch can trip up Eleventy's watch function, because your file might get saved while you're in the middle of typing. If this happens, Eleventy might not be able to recover. Click the Tools button then Logs to see the output and errors, if any. There's a 'Console' button there where if your project needs to be forced to restart, you can type in `refresh` and the enter, and your project will start over. +## Deploy your own + +Deploy your own 11ty project with Azion. + +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-link-in-bio "Deploy with Azion") -## Icon Credits -Icons for this project came from [IconFinder](https://www.iconfinder.com/icons/3775424/chemical_links_connection_connections_link_scheme_molecule_network_web_icon_icon). If you don't like them, upload your own (one in each size) to `assets` (click the assets button in your file list on Glitch) and update the URLs in `src/_data/siteData.json`. Once you've uploaded an asset in `assets` on Glitch, click the image to see its CDN URL. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). From c19a959cd5f849e84b83ea2c0e99e017b9c55fb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 14:52:22 -0300 Subject: [PATCH 03/76] refactor: update readme - 11ty micro site --- .../eleventy/eleventy-micro-site/readme.md | 68 ++++++------------- 1 file changed, 20 insertions(+), 48 deletions(-) diff --git a/templates/eleventy/eleventy-micro-site/readme.md b/templates/eleventy/eleventy-micro-site/readme.md index 36b2f824..f0fce295 100644 --- a/templates/eleventy/eleventy-micro-site/readme.md +++ b/templates/eleventy/eleventy-micro-site/readme.md @@ -1,60 +1,32 @@ -![Microsite GitHub Banner](./assets/banner.jpg) +# 11ty Micro Site -Opinionated micro front-end that can be used to _create a one-pager_. Great for landing pages or sign-up pages. It uses the static site generator [Eleventy (11ty)][11ty] under the hood and sets _common 11ty defaults_. +The **11ty Micro Site** template facilitates the deployment of an opinionated micro front-end that can be used to create a one-pager, great for landing pages or sign-up pages. It uses the static site generator Eleventy (11ty) under the hood and sets common 11ty defaults. -## Features ✨ +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/use-a-template-via-azion-console/). -* Inlines and minifies CSS using [`clean-css`][css] -* Inlines and minifies JavaScript using [`terser`][terser] -* Includes a `metadata.json` [global data file][data] -* Includes a `base.njk` [layout template][layout] -* Includes a `assets folder` for [static files][copy] (images, fonts etc.) +This template uses Eleventy version `0.11.1`. -> This is a _*skeleton project_ so it doesn't include any components or basic styling. It's a _*bring your own_ front-end. +> **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. -## Usage +--- -1. Update the `metadata.json` file with your own site details -2. Edit the `index.njk` file and start coding your website! +## Requirements -## Deploy Your Own +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own 11ty project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-micro-site "Deploy with Azion") -## Project Structure - -``` -micro-site/ -├── _site/ // output folder of 11ty -├── _data/ -│ └── metadata.json // metadata for the website -├── _includes/ -│ ├── style.css // minified and inlined -│ ├── script.js // minified and inlined -│ └── base.njk // base layout -├── assets/ // passtrough copy -├── index.njk/ // landing page -└── .eleventy.js // 11ty configurations -``` - -## Roadmap - -- [ ] Image optimization with `eleventy-image` -- [ ] Asset caching with `eleventy-cache-assets` -- [ ] Syntax highlighting support with `eleventy-plugin-syntaxhiglight` -## License - -[MIT][license] © [Danny de Vries][author] - -[11ty]: https://www.11ty.io/] -[nunjucks]: https://mozilla.github.io/nunjucks/ -[deploy]: https://app.netlify.com/start/deploy?repository=https://github.com/voightco/micro-site -[css]: https://github.com/jakubpawlowicz/clean-css -[terser]: https://github.com/terser/terser -[data]: https://www.11ty.dev/docs/data/ -[layout]: https://www.11ty.dev/docs/layouts/ -[copy]: https://www.11ty.dev/docs/copy/ -[author]: https://github.com/dandevri -[license]: license +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 14349290b59d46a6f437f5e23b5dc223aa7723e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:14:56 -0300 Subject: [PATCH 04/76] refactor: update readme - 11ty photo gallery --- .../eleventy/eleventy-photo-gallery/README.md | 90 ++++--------------- 1 file changed, 18 insertions(+), 72 deletions(-) diff --git a/templates/eleventy/eleventy-photo-gallery/README.md b/templates/eleventy/eleventy-photo-gallery/README.md index df64f543..4163aa6f 100644 --- a/templates/eleventy/eleventy-photo-gallery/README.md +++ b/templates/eleventy/eleventy-photo-gallery/README.md @@ -1,88 +1,34 @@ # Eleventy Photo Gallery -A starter site for creating your own photo or art gallery using the [Eleventy](https://github.com/11ty/eleventy) static site generator. +The **11ty Photo Gallery** allows you to create your own photo or art gallery with the Eleventy static site generator. -- [Live demo](https://f1dp73qktv.map.azionedge.net) - View the project live +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/use-a-template-via-azion-console/). -## Deploy Your Own +This template uses Eleventy version `2.0.1`. -Deploy your own 11ty project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-photo-gallery "Deploy with Azion") - -## Features -- Build-time image transformations and responsive image markup in templates with @11ty/eleventy-img -- High performance site with 100s across the board on each page -- Home page with CSS grid displaying the gallery of images -- Featured image pages -- Gallery page -- About me page -- Sass - -## Local Setup -1. Clone this repo: `git clone https://github.com/tannerdolby/eleventy-photo-gallery.git` -2. Navigate to your local copy of the project: `cd eleventy-photo-gallery` -3. Install dependencies: `npm install` -4. Build: `npm run build` -5. Serve locally: `npm run start` or `npm run dev` - -## Usage -Add images to a folder in your project and then supply image metadata in the global data file `_data/gallery.json`: - -``` -{ - "title": "Terrace with green plants on night street", - "date": "October 20, 2020", - "credit": "Photo by Aldiyar Seitkassymov", - "linkToAuthor": "https://www.pexels.com/photo/terrace-with-green-plants-on-night-street-3100835/", - "src": "terrace-window.jpg", - "alt": "Terrace outside shop window with green plants and pink tree on night street", - "widths": [320, 640, 1024], - "sizes": "(min-width: 450px) 33.3vw, 100vw", - "class": "my-img", - imgDir: "./src/images/" -} -``` +[Live demo](https://f1dp73qktv.map.azionedge.net) - View the project live -Once the image data is supplied within the global data file `_data/gallery.json` then the home page gallery images and featured image pages will display responsive images with `` after the sets of images are generated by the `img` shortcode in your templates. +> **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. -Or simply define the image metadata in frontmatter or directly inside the shortcode. Any of the options work to generate responsive images (if not already generated) with the corresponding markup. If the image is already generated in your project files, the utility will only render the responsive image markup with ``. +--- -### Creating responsive images in templates +## Requirements -1. Get a large image from somewhere (your file system, a stock photo website, etc) -2. Add the original image to the `src/images/` folder (or a folder of your choice). -3. Use the `img` shortcode to generate responsive image markup -4. This performs image transformations at build-time, creating varying image dimensions the specified formats (`.jpg`, `.webp`, etc) from the original image, which outputs to the specified `outputDir` in the `img` shortcode within .eleventy.js: +Before using this template, you need to: -``` -{% img - src="car.jpg", - alt="A photo of a car", - sizes="(max-width: 450px) 33.3vw, 100vw", - className="my-img", -%} -``` +- 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. -If you have already transformed an image and wish to only generate the responsive image markup using ``, simply use the `img` shortcode again anywhere within your templates to generate the responsive image markup. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -## Compiling Sass to CSS -All of the projects CSS is compiled from Sass at build-time. The main Sass file is `src/_includes/sass/style.scss` and thats where partials, mixins, and variables are loaded in with `@use` rules. +--- -If you want to change up the styles, you can write Sass (_or CSS_) directly in `style.scss` for the changes to be compiled and used. Otherwise, if you want to continue using a "modular" approach like the project follows. You can: +## Deploy your own -1. Create a new partial file in a specific directory ('sass/partials', 'sass/mixins', 'sass/vars') like `_some-file.scss` where the underscore prefixed at the beginning signals that the file is a [partial](https://sass-lang.com/documentation/at-rules/use#partials). These files are meant to be loaded as modules and not directly compiled. - -2. Write Sass code and style away! - -3. Load the stylesheets with a `@forward` rule in the [index files](https://sass-lang.com/documentation/at-rules/use#index-files) like `@forward "./some-file";` within `_index.scss` within the directory so they can be loaded with `@use` in the scss file that is compiled to CSS. - -4. Load the stylesheets using `@use` rules from the directory in which you need a specific file. Therefore, if I created a new file within `sass/mixins` called `_url-short.scss` and wanted to load that file in `style.scss`, I would use `@use "mixins" as *` to load the stylesheets within the `mixins` directory as one module while also ensuring the module isn't loaded with a namespace. - -_Read more about loading members and namespaces here in [Sass docs](https://sass-lang.com/documentation/at-rules/use#loading-members)_ +Deploy your own 11ty project with Azion. -## Contributing -Feel free to contribute to this project by suggesting a new feature or modification. I built this template for others to use, so let me know what you'd like to see added/modified. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-photo-gallery "Deploy with Azion") -- Open an [issue](https://github.com/tannerdolby/11ty-photo-gallery/issues) for any features/modifications you'd like to see! -- Have a look at the [contributing guidelines](https://github.com/tannerdolby/11ty-photo-gallery/blob/master/CONTRIBUTING.md) before submitting a PR! +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From e7e269665573d37ed565ddc2c0e59c9a8a95938c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:21:19 -0300 Subject: [PATCH 05/76] refactor: update readme - 11ty portfolio --- .../README.md | 84 +++++-------------- 1 file changed, 19 insertions(+), 65 deletions(-) diff --git a/templates/eleventy/eleventy-dark-portfolio-template-11ty/README.md b/templates/eleventy/eleventy-dark-portfolio-template-11ty/README.md index 2f32ec82..6f4dcb95 100644 --- a/templates/eleventy/eleventy-dark-portfolio-template-11ty/README.md +++ b/templates/eleventy/eleventy-dark-portfolio-template-11ty/README.md @@ -1,80 +1,34 @@ -# Dark-Portfolio-Template-11ty +# 11ty Portfolio -A starter repository showing how to build a blog with the [Eleventy](https://github.com/11ty/eleventy) static site generator. -Uses the W3CSS template "Dark Portfolio Template" +The **11ty Portfolio** template is a starter repository showing how to build a portfolio with the 11ty static site generator. It uses the W3CSS template "Dark Portfolio Template". -[![Build Status](https://travis-ci.com/jmschrack/Dark-Portfolio-Template-11ty.svg?branch=dev)](https://travis-ci.org/jmschrack/dark-portfolio-template-11ty) +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/use-a-template-via-azion-console/). +This template uses Eleventy version `0.10.0`. -## Deploy Your Own +[Live demo](https://ua0f7vcocv.map.azionedge.net) - View the project live -Deploy your own 11ty project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-portfolio "Deploy with Azion") - -## Demos - -* [Azion](https://ua0f7vcocv.map.azionedge.net) - - -## Getting Started - -### 1. Clone this Repository +> **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. -``` -git clone https://github.com/jmschrack/Dark-Portfolio-Template-11ty.git my-blog-name -``` +--- +## Requirements -### 2. Navigate to the directory +Before using this template, you need to: -``` -cd my-blog-name -``` +- 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. -Specifically have a look at `.eleventy.js` to see if you want to configure any Eleventy options differently. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -### 3. Install dependencies +--- -``` -npm install -``` +## Deploy your own -### 4. Edit _data/metadata.json - -### 5. Run Eleventy - -``` -npx eleventy -``` - -Or build and host locally for local development -``` -npx eleventy --serve -``` - -Or build automatically when a template changes: -``` -npx eleventy --watch -``` - -Or in debug mode: -``` -DEBUG=* npx eleventy -``` - -### Implementation Notes +Deploy your own 11ty project with Azion. -* `about/index.md` shows how to add a content page. -* `posts/` has the blog posts but really they can live in any directory. They need only the `post` tag to be added to this collection. -* Add the `nav` tag to add a template to the top level site navigation. For example, this is in use on `index.njk` and `about/index.md`. -* Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in `.eleventy.js` -> `templateFormats`. - * Because `css` and `png` are listed in `templateFormats` but are not supported template types, any files with these extensions will be copied without modification to the output (while keeping the same directory structure). -* The blog post feed template is in `feed/feed.njk`. This is also a good example of using a global data files in that it uses `_data/metadata.json`. -* This example uses three layouts: - * `_includes/layouts/base.njk`: the top level HTML structure - * `_includes/layouts/home.njk`: the home page template (wrapped into `base.njk`) - * `_includes/layouts/post.njk`: the blog post template (wrapped into `base.njk`) -* `_includes/postlist.njk` is a Nunjucks include and is a reusable component used to display a list of all the posts. `index.njk` has an example of how to use it. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-portfolio "Deploy with Azion") -* The latest 6 blog posts with the "photo" tag wil be used in the photo gallery. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 06f992aa198796b92de8fe7fdd12170009d5343a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:40:11 -0300 Subject: [PATCH 06/76] refactor: update readme - 11ty shop --- .../eleventy/eleventy-11ty-shop/README.md | 33 ++++++++++--------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/templates/eleventy/eleventy-11ty-shop/README.md b/templates/eleventy/eleventy-11ty-shop/README.md index b38c77b4..201af6b7 100644 --- a/templates/eleventy/eleventy-11ty-shop/README.md +++ b/templates/eleventy/eleventy-11ty-shop/README.md @@ -1,29 +1,32 @@ -# 11tyshop +# 11ty Shop -![heladess online shop](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEiFqb7c3xCeMahPABf7isdylCHMMfPEm5SM2m_T4QWSRrPBgep_jiTe2Z5AcQJ-qNylCQkuMK9dBmaU0oo0muvDSey4vdbtpLu7cArRWivnp5D_C5vQFfZnd0H01wOsk2FQeRHwKW1uBc1l1KueL1VJHGRb7LNi6CCrfMeb4VQBgKPYxjo4DuHU6TDK-A/s600/shop11ty.webp) +The **11ty Shop** template helps you to easily deploy an online shop built with 11ty. -Eleventy 11ty static site generator online shop integrate ecwid free download source code !! +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/use-a-template-via-azion-console/). -Starter online shop 11ty ecwid project. +This template uses Eleventy version `2.0.0-canary.14`. -online shop with markdown just input product id and run your online shop. +> **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 11ty project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-shop "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/) and [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. -## Performance Test +--- -![heladess 11ty eleventy ecwid online shop](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEg51D8lYDOJ9xP5pDzUuajKGpkhK6z1FdGltnIq0zcB-Ji-8IGwHFixWSMx745MQ2WhYsxgL37wYZqValFEFFOYrdHUtarKr7PVgyRbzKz-2Pp9SiAr9OqYNnxePDZJ2rSyRj5VThF8xkLfBphsFAgRYQn8yESFXO-n256BqSz0pP3N3tiedQF4EzHh4Q/s1349/speed%20online%20shop%20seo.webp) +## Deploy your own +Deploy your own 11ty project with Azion. -## Design UI +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-shop "Deploy with Azion") -![heladess online shop](./img/shoot11tyshop.webp) -![11ty eleventy online shop](./img/shoot11tyshop1.webp) -![e-commerce online shop](./img/shoot11tyshop2.webp) -![statci site geenrator 11ty eleventy ecwid online shop](./img/shoot11tyshop3.webp) +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From d7b847ca66a19793c5731b1e1c46751b52463067 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:45:38 -0300 Subject: [PATCH 07/76] refactor: update readme - 11ty Starter Kit --- .../eleventy-11st-starter-kit/README.md | 34 +++++++++++-------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/templates/eleventy/eleventy-11st-starter-kit/README.md b/templates/eleventy/eleventy-11st-starter-kit/README.md index c76aefaf..53e0ba7c 100644 --- a/templates/eleventy/eleventy-11st-starter-kit/README.md +++ b/templates/eleventy/eleventy-11st-starter-kit/README.md @@ -1,28 +1,32 @@ -# 📦 11st-Starter-Kit +# 11ty Starter Kit -[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +With the **11ty Starter Kit**, tart your own 11ty application, powered by Vite, Tailwind CSS, and Alpine.js. -[11ty](https://www.11ty.dev/), powered by [Vite](https://vitejs.dev/) -with [Tailwind CSS](https://tailwindcss.com) and -[Alpine.js](https://github.com/alpinejs/alpine/). +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/use-a-template-via-azion-console/). -## Deploy Your Own +This template uses Eleventy version `2.0.1`, TailwindCSS version `3.3.3`, and Alpine.js version `3.11.1`. -Deploy your own 11ty project with Azion. +> **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 Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-stater-kit "Deploy with Azion") +--- +## Requirements -## Code Quality +Before using this template, you need to: -By default `CSS` and `JavaScript` is getting linted with every commit. +- 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. -You can lint manually by running `npm run lint` and if errors occur you can try to fix them automatically by running `npm run format`. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -With every pull request it is checked if the code can be build without errors and afterwards `CSS` and `JavaScript` is getting linted. +--- -Additionally each page is audited by Lighthouse which can take some time. You can find the performance budget for this audit in the file `./budget.json`. +## Deploy your own -## License +Deploy your own 11ty project with Azion. + +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-stater-kit "Deploy with Azion") -This project is open source and available under the [MIT License](LICENSE). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From d6ba4501399828a4c10282fcfeccb1e85b06a641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:28:38 -0300 Subject: [PATCH 08/76] refactor: update readme - Mobile11ty --- .../eleventy/eleventy-mobile11ty/README.md | 65 +++++-------------- 1 file changed, 17 insertions(+), 48 deletions(-) diff --git a/templates/eleventy/eleventy-mobile11ty/README.md b/templates/eleventy/eleventy-mobile11ty/README.md index 3ce030ed..fdc0a5f8 100644 --- a/templates/eleventy/eleventy-mobile11ty/README.md +++ b/templates/eleventy/eleventy-mobile11ty/README.md @@ -1,63 +1,32 @@ -# mobile11ty ----------------------------------------------- +# Mobile11ty +The **Mobile11ty** template allows you to build a website and an Android app all in one, based on Eleventy (11ty). -![eleventy mobile11ty template themes](mobile11ty.jpg) +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/use-a-template-via-azion-console/). +This template uses Eleventy version `2.0.0-canary.14`. -Documentation : [https://www.hockeycomputindo.com/2022/04/new-mobile11ty-eleventy-build-website.html](https://www.hockeycomputindo.com/2022/04/new-mobile11ty-eleventy-build-website.html) +> **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. -Test Drive Demo : [https://ytzmhg7jpb.map.azionedge.net](https://ytzmhg7jpb.map.azionedge.net) - -Developer : [eleventy.web.app](https://eleventy.web.app/) - ---- -### Deploy Your Own - -Deploy your own 11ty project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/mobile11ty "Deploy with Azion") --- ---------------------------------- - -Display - - -![eleventy mobile11ty template themes](desktop.png) - - -Desktop version +## Requirements +Before using this template, you need to: -![eleventy mobile11ty template themes](mobile.png) +- 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/) and [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. -Mobile version - ----------------------- - -Android Run - -![install android 11ty](android/11tyandroid.jpg) - -For test demo you can donwload this apk on your smartphone [download android apk here →](https://github.com/mesinkasir/mobile11ty/raw/main/android/mobile11ty.apk) -+ Download android apk -+ Change app permissions on your Android phone -+ Run Install -+ Open Android App - -![install android 11ty](android/android11ty.jpg) - ---------------------------------- - - -Documentation : [https://www.hockeycomputindo.com/2022/04/new-mobile11ty-eleventy-build-website.html](https://www.hockeycomputindo.com/2022/04/new-mobile11ty-eleventy-build-website.html) - -Test Drive Demo : [https://mobile11ty.pages.dev](https://mobile11ty.pages.dev) +--- +## Deploy your own -Video test drive demo : [https://www.youtube.com/watch?v=PmwZttbMYm8](https://www.youtube.com/watch?v=PmwZttbMYm8) +Deploy your own 11ty project with Azion. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/mobile11ty "Deploy with Azion") -Developer : [eleventy.web.app](https://eleventy.web.app/) \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 13011a43ca2ec8966b71970a56287ffd56cc9f85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:45:59 -0300 Subject: [PATCH 09/76] refactor: update readme - Eleventy 2 Snipcart --- .../eleventy/eleventy-2-snipcart/README.md | 32 +++++++++++-------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/templates/eleventy/eleventy-2-snipcart/README.md b/templates/eleventy/eleventy-2-snipcart/README.md index 005a09d8..d7030244 100644 --- a/templates/eleventy/eleventy-2-snipcart/README.md +++ b/templates/eleventy/eleventy-2-snipcart/README.md @@ -1,26 +1,32 @@ -# Learn 11ty: A JavaScript Static Site Generator Tutorial +# Eleventy 2 Snipcart -Ever heard of 11ty? It's a simple static site generator written in JavaScript. In this tutorial, we craft a small e-commerce app, exploring its set of features in the process. +The **Eleventy 2 Snipcart** template deploys a simple e-commerce or catalog site, making it ideal for testing and becoming familiar with JavaScript and the Eleventy (11ty) framework. The deployment will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project. + +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/eleventy-ecommerce-collection/). + +This template uses Eleventy version `0.5.4`. + +> **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 Eleventy 2 Snipcart project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/eleventy-to-snipcart "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. --- -Steps: - -- Setting up a web store with Eleventy. -- Creating products and injecting a cart. -- Adding code highlighting to blog posts! -- Outputting a JSON file for products. +## Deploy your own -> Read the post & tutorial [here](https://snipcart.com/blog/11ty-javascript-static-site-generator-tutorial) +Deploy your own Eleventy 2 Snipcart project with Azion. -Enjoy folks! +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/eleventy-to-snipcart "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/eleventy-ecommerce-collection/). \ No newline at end of file From 5d6834ce5e6432753b1e4743237567a034261e17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:52:27 -0300 Subject: [PATCH 10/76] refactor: update readme - Eleventy and Snipcart for eCommerce --- .../jamstack-tapas-snipcart-store/README.md | 51 +++++++++---------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/templates/eleventy/jamstack-tapas-snipcart-store/README.md b/templates/eleventy/jamstack-tapas-snipcart-store/README.md index 098d5c41..8c0bf53b 100644 --- a/templates/eleventy/jamstack-tapas-snipcart-store/README.md +++ b/templates/eleventy/jamstack-tapas-snipcart-store/README.md @@ -1,33 +1,32 @@ -# 11ty and Snipcart for eCommerce +# Eleventy and Snipcart for eCommerce -## Deploy Your Own +The **Eleventy and Snipcart for eCommerce** template is based on the Eleventy framework and integrated with Snipcart, a solution for adding shopping carts and accepting payments. This template allows you to easily deploy an e-commerce or online store with fully functional capabilities. -Deploy your own Eleventy and Snipcart for eCommerce project with Azion. +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/eleventy-ecommerce-collection/). -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/eleventy-snipcart-for-ecommerce "Deploy with Azion") +This template uses Eleventy version `2.0.1`. +> **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. --- -- [Snipcart](https://snipcart.com/) and [Snipcart for developers](https://snipcart.com/ecommerce-for-developers) -- Words great with Jamstack and without! -- Simple startup: - - Sign up, get API key - - Include some JavaScript - - Encode product data using - `data-*` attributes of HTML - -``` - -``` - -Check out `src/index.liquid` and `src/_data/products.json` as a good place to start seeing how Snipcart is easily implemented. - -image +## Requirements + +Before using this template, you need to: + +- 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. + +--- + +## Deploy your own + +Deploy your own Eleventy and Snipcart for eCommerce project with Azion. + +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/eleventy-snipcart-for-ecommerce "Deploy with Azion") + +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/eleventy-ecommerce-collection/). From d5a5b8c8d76b41aff64fa728c405933406652ad1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:58:34 -0300 Subject: [PATCH 11/76] refactor: update readme - 11ty Base Blog --- templates/eleventy/eleventy-static/README.md | 113 +++---------------- 1 file changed, 17 insertions(+), 96 deletions(-) diff --git a/templates/eleventy/eleventy-static/README.md b/templates/eleventy/eleventy-static/README.md index 73e1fa1d..3b713ddb 100644 --- a/templates/eleventy/eleventy-static/README.md +++ b/templates/eleventy/eleventy-static/README.md @@ -1,113 +1,34 @@ -# eleventy-base-blog v8 +## 11ty Base Blog -A starter repository showing how to build a blog with the [Eleventy](https://www.11ty.dev/) site generator (using the [v2.0 release](https://www.11ty.dev/blog/eleventy-v2/)). +The **11ty Base Blog** template is a starter template showing how to build a blog with the Eleventy site generator. -## Getting Started +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/use-a-template-via-azion-console/). -* [Want a more generic/detailed getting started guide?](https://www.11ty.dev/docs/getting-started/) +This template uses Eleventy version `2.0.1`. -1. Make a directory and navigate to it: +[Live demo](https://jclg2ljbur.map.azionedge.net) - View the project live -``` -mkdir my-blog-name -cd my-blog-name -``` +> **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. -2. Clone this Repository +--- -``` -git clone https://github.com/11ty/eleventy-base-blog.git . -``` +## Requirements -_Optional:_ Review `eleventy.config.js` and `_data/metadata.js` to configure the site’s options and data. +Before using this template, you need to: -3. Install dependencies +- 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. -``` -npm install -``` +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -4. Run Eleventy +--- -Generate a production-ready build to the `_site` folder: - -``` -npx @11ty/eleventy -``` - -Or build and host on a local development server: - -``` -npx @11ty/eleventy --serve -``` - -Or you can run [debug mode](https://www.11ty.dev/docs/debugging/) to see all the internals. - -## Features - -- Using [Eleventy v2.0](https://www.11ty.dev/blog/eleventy-v2/) with zero-JavaScript output. - - Content is exclusively pre-rendered (this is a static site). - - Can easily [deploy to a subfolder without changing any content](https://www.11ty.dev/docs/plugins/html-base/) - - All URLs are decoupled from the content’s location on the file system. - - Configure templates via the [Eleventy Data Cascade](https://www.11ty.dev/docs/data-cascade/) -- **Performance focused**: four-hundos Lighthouse score out of the box! - - [View the Lighthouse report for the latest build](https://eleventy-base-blog.netlify.app/reports/lighthouse/) courtesy of the [Netlify Lighthouse plugin](https://github.com/netlify/netlify-plugin-lighthouse). - - _0 Cumulative Layout Shift_ - - _0ms Total Blocking Time_ -- Local development live reload provided by [Eleventy Dev Server](https://www.11ty.dev/docs/dev-server/). -- Content-driven [navigation menu](https://www.11ty.dev/docs/plugins/navigation/) -- [Image optimization](https://www.11ty.dev/docs/plugins/image/) via the `{% image %}` shortcode. - - Zero-JavaScript output. - - Support for modern image formats automatically (e.g. AVIF and WebP) - - Prefers `` markup if possible (single image format) but switches automatically to `` for multiple image formats. - - Automated `` syntax markup with `srcset` and optional `sizes` - - Includes `width`/`height` attributes to avoid [content layout shift](https://web.dev/cls/). - - Includes `loading="lazy"` for native lazy loading without JavaScript. - - Includes [`decoding="async"`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/decoding) - - Images can be co-located with blog post files. - - View the [Image plugin source code](https://github.com/11ty/eleventy-base-blog/blob/main/eleventy.config.images.js) -- Per page CSS bundles [via `eleventy-plugin-bundle`](https://github.com/11ty/eleventy-plugin-bundle). -- Built-in [syntax highlighter](https://www.11ty.dev/docs/plugins/syntaxhighlight/) (zero-JavaScript output). -- Blog Posts - - Draft posts: use `draft: true` to mark a blog post as a draft. Drafts are **only** included during `--serve`/`--watch` and are excluded from full builds. View the [Drafts plugin source code](https://github.com/11ty/eleventy-base-blog/blob/main/eleventy.config.drafts.js). - - Automated next/previous links - - Accessible deep links to headings -- Generated Pages - - Home, Archive, and About pages. - - [Feeds for Atom and JSON](https://www.11ty.dev/docs/plugins/rss/) - - `sitemap.xml` - - Zero-maintenance tag pages ([View on the Demo](https://eleventy-base-blog.netlify.app/tags/)) - - Content not found (404) page - -## Demos - -- [Azion](https://jclg2ljbur.map.azionedge.net) - -## Deploy Your Own +## Deploy your own Deploy your own 11ty project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/11ty/11ty-base-blog "Deploy with Azion") -### Implementation Notes - -- `content/about/index.md` is an example of a content page. -- `content/blog/` has the blog posts but really they can live in any directory. They need only the `posts` tag to be included in the blog posts [collection](https://www.11ty.dev/docs/collections/). -- Use the `eleventyNavigation` key (via the [Eleventy Navigation plugin](https://www.11ty.dev/docs/plugins/navigation/)) in your front matter to add a template to the top level site navigation. This is in use on `content/index.njk` and `content/about/index.md`. -- Content can be in _any template format_ (blog posts needn’t exclusively be markdown, for example). Configure your project’s supported templates in `eleventy.config.js` -> `templateFormats`. -- The `public` folder in your input directory will be copied to the output folder (via `addPassthroughCopy` in the `eleventy.config.js` file). This means `./public/css/*` will live at `./_site/css/*` after your build completes. -- Provides two content feeds: - - `content/feed/feed.njk` - - `content/feed/json.njk` -- This project uses three [Eleventy Layouts](https://www.11ty.dev/docs/layouts/): - - `_includes/layouts/base.njk`: the top level HTML structure - - `_includes/layouts/home.njk`: the home page template (wrapped into `base.njk`) - - `_includes/layouts/post.njk`: the blog post template (wrapped into `base.njk`) -- `_includes/postslist.njk` is a Nunjucks include and is a reusable component used to display a list of all the posts. `content/index.njk` has an example of how to use it. - -#### Content Security Policy - -If your site enforces a [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) (as public-facing sites should), you have a few choices (pick one): - -1. In `base.njk`, remove `` and uncomment `` -2. Configure the server with the CSP directive `style-src: 'unsafe-inline'` (less secure). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From bac388c5ca27cc6ec719af176b5e44101d19f4ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 22 Oct 2024 17:06:37 -0300 Subject: [PATCH 12/76] Update README.md --- templates/eleventy/eleventy-mobile11ty/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/templates/eleventy/eleventy-mobile11ty/README.md b/templates/eleventy/eleventy-mobile11ty/README.md index fdc0a5f8..eaf75714 100644 --- a/templates/eleventy/eleventy-mobile11ty/README.md +++ b/templates/eleventy/eleventy-mobile11ty/README.md @@ -4,6 +4,8 @@ The **Mobile11ty** template allows you to build a website and an Android app all 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/use-a-template-via-azion-console/). +[Live demo](https://ytzmhg7jpb.map.azionedge.net) - View the project live + This template uses Eleventy version `2.0.0-canary.14`. > **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. From 556d4627e6246c3c5be833706bb1fe3c0f54a85e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:33:16 -0300 Subject: [PATCH 13/76] refactor: update readme - Vue3/Vite --- templates/vue/vue3-vite-static/README.md | 67 ++++-------------------- 1 file changed, 9 insertions(+), 58 deletions(-) diff --git a/templates/vue/vue3-vite-static/README.md b/templates/vue/vue3-vite-static/README.md index fb6d6396..baf650a5 100644 --- a/templates/vue/vue3-vite-static/README.md +++ b/templates/vue/vue3-vite-static/README.md @@ -8,70 +8,21 @@ This template uses Vue version `3.3.4` and Vite version `4.4.6`. --- -## Deploy Your Own +## Requirements -Deploy your own Vite project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/vitejs/vitejs-vue3-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 Vue3/Vite Boilerplate](https://www.azion.com/en/documentation/products/guides/vue-vite-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 and Application Accelerator](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= -``` +- 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. -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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 [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. +Deploy your own Vue3/Vite project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/vitejs/vitejs-vue3-boilerplate "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/eleventy-ecommerce-collection/). \ No newline at end of file From e95e632f9abbd3c0122af4f77913cc9cc4400fb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:41:33 -0300 Subject: [PATCH 14/76] refactor: update readme - Vue Boilerplate --- templates/vue/vue3-vite-static/README.md | 2 +- templates/vue/vuejs-boilerplate/README.md | 69 ++++------------------- 2 files changed, 11 insertions(+), 60 deletions(-) diff --git a/templates/vue/vue3-vite-static/README.md b/templates/vue/vue3-vite-static/README.md index baf650a5..6aff745b 100644 --- a/templates/vue/vue3-vite-static/README.md +++ b/templates/vue/vue3-vite-static/README.md @@ -25,4 +25,4 @@ Deploy your own Vue3/Vite project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/vitejs/vitejs-vue3-boilerplate "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/eleventy-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vue-vite-boilerplate/). \ No newline at end of file diff --git a/templates/vue/vuejs-boilerplate/README.md b/templates/vue/vuejs-boilerplate/README.md index f319026c..401868c2 100644 --- a/templates/vue/vuejs-boilerplate/README.md +++ b/templates/vue/vuejs-boilerplate/README.md @@ -1,6 +1,6 @@ # Vue Boilerplate -The Azion **Vue Boilerplate** is designed to simplify and enhance the deployment process for Vue.js applications directly on the edge of the network. +The **Vue Boilerplate** is designed to simplify and enhance the deployment process for Vue.js applications directly on the edge of the network. 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 Vue Boilerplate](https://www.azion.com/en/documentation/products/guides/vue-boilerplate/) guide. @@ -8,70 +8,21 @@ This template uses Vue version `3.3.4`. --- -## Deploy Your Own +## Requirements -Deploy your own Vue project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/vue/vue-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. - -### 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. - -For a more detailed step-by-step on using this template and requirements, check the [How to deploy edge applications with the Vue Boilerplate](https://www.azion.com/en/documentation/products/guides/vue-boilerplate/) guide. +Before using this template, you need to: ---- - -## 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= -``` - -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 +## Deploy your own -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 Real-Time Manager (RTM)](https://manager.azion.com/). - -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 Vue project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/vue/vue-boilerplate "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/edge-application/domains/) documentation to read more about it. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vue-boilerplate/). \ No newline at end of file From 88dadc8056067398a4d6571013fcb4946926843e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:05:41 -0300 Subject: [PATCH 15/76] refactor: update readme - Vitepress JS + TS --- .../vitepress-boilerplate-js/README.md | 27 ++++++++++++++++--- .../vitepress-boilerplate-ts/README.md | 27 ++++++++++++++++--- 2 files changed, 48 insertions(+), 6 deletions(-) diff --git a/templates/vitepress/vitepress-boilerplate-js/README.md b/templates/vitepress/vitepress-boilerplate-js/README.md index be6c0dfa..7572f7e9 100644 --- a/templates/vitepress/vitepress-boilerplate-js/README.md +++ b/templates/vitepress/vitepress-boilerplate-js/README.md @@ -1,9 +1,30 @@ -# VitePress Boilerplate +# VitePress JavaScript Boilerplate -The VitePress Boilerplate is designed to simplify and enhance the deployment process for VitePress applications directly on the edge of the network. +The **VitePress JavaScript Boilerplate** allows you to deploy a static project on the edge quickly and easily. VitePress, a static site generator built on top of Vite and Vue.js, is ideal for creating documentation websites with features including a markdown-based content system, a built-in theming system, and fast hot module replacement. -## Deploy Your Own +This template, written in *JavaScript*, creates a GitHub repository containing your project, as well as an edge application and a domain to facilitate your access and management through Azion Edge Platform. + +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 the VitePress JavaScript Boilerplate](https://www.azion.com/en/documentation/products/guides/vitepress-javascript-boilerplate/) guide. + +VitePress JavaScript Boilerplate uses VitePress version `1.3.0`. + +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. + +--- + +## Deploy your own Deploy your own VitePress project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/vitepress/vitepress-javascript-boilerplate "Deploy with Azion") + +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vitepress-javascript-boilerplate/). \ No newline at end of file diff --git a/templates/vitepress/vitepress-boilerplate-ts/README.md b/templates/vitepress/vitepress-boilerplate-ts/README.md index 5ac99771..5d050eda 100644 --- a/templates/vitepress/vitepress-boilerplate-ts/README.md +++ b/templates/vitepress/vitepress-boilerplate-ts/README.md @@ -1,9 +1,30 @@ -# VitePress Boilerplate +# VitePress Typescript Boilerplate -The VitePress Boilerplate is designed to simplify and enhance the deployment process for VitePress applications directly on the edge of the network. +The **VitePress Typescript Boilerplate** allows you to deploy a static project on the edge quickly and easily. VitePress, a static site generator built on top of Vite and Vue.js, is ideal for creating documentation websites with features including a markdown-based content system, a built-in theming system, and fast hot module replacement. -## Deploy Your Own +This template, written in *Typescript*, creates a GitHub repository containing your project, as well as an edge application and a domain to facilitate your access and management through Azion Edge Platform. + +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 the VitePress Typescript Boilerplate](https://www.azion.com/en/documentation/products/guides/vitepress-typescript-boilerplate/) guide. + +VitePress Typescript Boilerplate uses VitePress version `1.3.0`. + +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. + +--- + +## Deploy your own Deploy your own VitePress project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/vitepress/vitepress-typescript-boilerplate "Deploy with Azion") + +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/vitepress-typescript-boilerplate/). \ No newline at end of file From a79e89ff46d82f5855da31e2b249dc0f2ddc2a9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:25:58 -0300 Subject: [PATCH 16/76] refactor: update readme - Svelte --- templates/svelte/svelte-static/README.md | 34 ++++++------------------ 1 file changed, 8 insertions(+), 26 deletions(-) diff --git a/templates/svelte/svelte-static/README.md b/templates/svelte/svelte-static/README.md index a87f8938..042cf632 100644 --- a/templates/svelte/svelte-static/README.md +++ b/templates/svelte/svelte-static/README.md @@ -2,45 +2,27 @@ The **Svelte Boilerplate** streamlines the deployment of a static application based on the Svelte framework, directly on the edge of the network, accelerating and automating the overall process. -The template deploys an edge application, a domain, and a related GitHub repository to facilitate your access and management. The repository also includes a GitHub Action to ensure a continuous deployment workflow, keeping your project up to date. - 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 Svelte Boilerplate](https://www.azion.com/en/documentation/products/guides/svelte-boilerplate/) guide. This template uses Svelte version `4.2.7` and Vite version `5.0.3`. --- -## 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. +## Requirements -To successfully deploy this template, you must provide the information to configure your Azion application, as requested in the configuration form. +Before using this template, you need to: -For a more detailed step-by-step on using this template and requirements, check the [How to deploy edge applications with the Svelte Boilerplate](https://www.azion.com/en/documentation/products/guides/svelte-boilerplate/) guide. +- 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. -### Requirements +> **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. -- A [GitHub account](https://github.com/signup) to connect with Azion and create your new repository. - - Every push will be deployed automatically to this repository to keep your project updated. - --- -## Management - -Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need using [Azion Console](https://console.azion.com/). - -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 - -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 Your Own +## Deploy your own Deploy your own Svelte project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/svelte/svelte-boilerplate "Deploy with Azion") + +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/svelte-boilerplate/). From 2968256de13fd5a9cf116f6ff42ca5d88de2af08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:42:50 -0300 Subject: [PATCH 17/76] refactor: update readme - Book Store React --- templates/react/book-store-react/README.md | 78 ++++------------------ 1 file changed, 13 insertions(+), 65 deletions(-) diff --git a/templates/react/book-store-react/README.md b/templates/react/book-store-react/README.md index 805c82a1..0ced9aae 100644 --- a/templates/react/book-store-react/README.md +++ b/templates/react/book-store-react/README.md @@ -1,80 +1,28 @@ - +# Book Store React -

BOOK Ecommerce STORE USING REACTJS

+The **Book Store React** template is based on a React web application where the users can search for a book by its title and later can add it to the shopping cart and finally purchase using a credit card transaction. It's built with ReactJS, Javascript, HTML, and CSS, and uses CommerceJS and Stripe integrations for backend and payment. +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 an e-commerce using the Book Store React template](https://www.azion.com/en/documentation/products/guides/book-store-react/) guide. -# BOOK Shop Description - Book Shop is an online React web application where the customer can purchase books online. - Through this book store the users can search for a book by its title and - later can add to the shopping cart and finally purchase using credit card transaction. +This template uses React version `16.13.1`. --- -## Deploy Your Own +## Requirements -Deploy your own Book Store React project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/book-store-react "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. --- - - - ![Alt text](https://github.com/Akshatjalan/Book-store-Reactjs/blob/main/src/assets/Web.jpg?raw=true "Main Page") - -# Tools Used - -- Build with `ReactJS`, `Javascript`, `HTML`, `CSS`. -- `CommerceJS` provides Backend eCommerce APIs for any frontend framework -- `Stripe` is used as a suite of payment APIs that powers commerce and provides temporary credit card for payment. -- https://commercejs.com/docs/guides/products-react/ Documentation of CommerceJS to fetch APIs -- https://stripe.com/docs/stripe-js/react Documentation to connect Stripe with React components for Stripe.js and Stripe Elements - - -# Installation - -### `npm start` - -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.
- -### `npm test` -Launches the test runner in the interactive watch mode.
-See the section about [running tests](#running-tests) for more information. +## Deploy your own -### `npm run build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-The app is ready to be deployed! - -See the section about [deployment](#deployment) for more information. - -## Contact -

- Akshat Jalan -

-

- - - - - - - - - - - - - - - +Deploy your own Book Store React project with Azion. -

+[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/book-store-react "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/book-store-react/). \ No newline at end of file From d3493426226dddff1706f984c1a34463eb97f5f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:51:31 -0300 Subject: [PATCH 18/76] refactor: update readme - React Boilerplate --- templates/react/reactjs-boilerplate/README.md | 66 +++---------------- 1 file changed, 9 insertions(+), 57 deletions(-) diff --git a/templates/react/reactjs-boilerplate/README.md b/templates/react/reactjs-boilerplate/README.md index 237ea2ca..6f64ecfd 100644 --- a/templates/react/reactjs-boilerplate/README.md +++ b/templates/react/reactjs-boilerplate/README.md @@ -8,69 +8,21 @@ This template uses React version `18.2.0`. --- -## Deploy Your Own +## Requirements -Deploy your own React project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/react/react-boilerplate "Deploy with Azion") - ---- - -## Usage Information - -To use this template, you must [sign in on Azion Console](https://console.azion.com/login). +Before using this template, you need to: -> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration. +- 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. -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 React Boilerplate](https://www.azion.com/en/documentation/products/guides/react-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. +> **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. --- -## 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. +## Deploy your own -```bash - AZION_PERSONAL_TOKEN= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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 Real-Time Manager (RTM)](https://manager.azion.com/). - -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 React project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/react/react-boilerplate "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/react-boilerplate/). \ No newline at end of file From 1a61bcb4504d464bf1b910c76a1dc5ea3971b72d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:13:43 -0300 Subject: [PATCH 19/76] refactor: update readme - Jekyll boilerplate --- templates/jekyll/jekyll-blog/README.md | 29 ++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/templates/jekyll/jekyll-blog/README.md b/templates/jekyll/jekyll-blog/README.md index 53edc1d6..0308c85a 100644 --- a/templates/jekyll/jekyll-blog/README.md +++ b/templates/jekyll/jekyll-blog/README.md @@ -1,9 +1,30 @@ -# Jekyll Blog Boilerplate +# Jekyll Boilerplate -Simplify the deployment of a static Jekyll project on the edge. +The **Jekyll Boilerplate** accelerates the deployment of a basic Jekyll project, directly on the edge of the network. -## Deploy Your Own +This template deploys a repository with a project based on Jekyll, a framework written in **Ruby**, that enables you to create static sites using Markdown and HTML files. + +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 the Jekyll Boilerplate](https://www.azion.com/en/documentation/products/guides/jekyll-boilerplate/) guide. + +This template uses Jekyll version `4.3.3`. + +--- + +## Requirements + +Before using this template, you need to: + +- 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. +- Install [Ruby version 2.5.0 or higher](https://jekyllrb.com/docs/ruby-101/). + - Without a Ruby runtime environment, you won’t be able to install the Jekyll gem or execute the Ruby code that powers Jekyll. + +--- + +## Deploy your own Deploy your own Jekyll project with Azion. -[![Deploy Button](/static/button.png)](https://console.azion.com/create/jekyll/jekyll-boilerplate "Deploy with Azion") \ No newline at end of file +[![Deploy Button](/static/button.png)](https://console.azion.com/create/jekyll/jekyll-boilerplate "Deploy with Azion") + +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/jekyll-boilerplate/). \ No newline at end of file From 29f5f35fefb10771fb86da108865a74646430700 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:23:48 -0300 Subject: [PATCH 20/76] refactor: update readme - jekyll cart --- templates/jekyll/jekyll-cart/README.md | 86 ++++++-------------------- 1 file changed, 18 insertions(+), 68 deletions(-) diff --git a/templates/jekyll/jekyll-cart/README.md b/templates/jekyll/jekyll-cart/README.md index 4a5710b2..41420ae2 100644 --- a/templates/jekyll/jekyll-cart/README.md +++ b/templates/jekyll/jekyll-cart/README.md @@ -1,85 +1,35 @@ # Jekyll Cart -Code Repo: https://github.com/bradonomics/jekyll-cart/
-Demo: http://bradonomics.github.io/jekyll-cart/ +The **Jekyll Cart** template allows you to build an e-commerce site with Jekyll using simpleCart(js), a JavaScript shopping cart that is easy to set up. The deployment will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project. ---- - -## Deploy Your Own +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/jekyll-ecommerce-collection/). -Deploy your own Jekyll Cart project with Azion. +This template uses Jekyll Cart version `0.1.0`. -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/jekyll-cart "Deploy with Azion") +> **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. +- Code Repo: https://github.com/bradonomics/jekyll-cart/
+- Demo: http://bradonomics.github.io/jekyll-cart/ --- -Jekyll Cart is a Jekyll based shopping cart built with simpleCart(js). It incorporates work from the following: - -### Jekyll - -Homepage: http://jekyllrb.com/
-GitHub Repo: https://github.com/jekyll/jekyll - -### Jekyll Boilerplate - -GitHub Repo: https://github.com/bradonomics/jekyll-boilerplate - -### simpleCart(js) - -Homepage: http://simplecartjs.org/
-GitHub Repo: https://github.com/wojodesign/simplecart-js - -### Fur Theme by CloudCannon - -Homepage: https://turquoise-rook.cloudvent.net/
-GitHub Repo: https://github.com/CloudCannon/fur-jekyll-template - -## Getting Started +## Requirements -You can [download the files from GitHub](https://github.com/bradonomics/jekyll-cart/archive/master.zip) (or clone the repo: `git clone https://github.com/bradonomics/jekyll-cart.git`) and have a fully functioning Jekyll site with shopping cart in minutes. +Before using this template, you need to: -### Develop +- 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. -Jekyll Cart was built with Jekyll v3.4.3, but should support newer versions also. +> **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. -Install the dependencies with [Bundler](http://bundler.io/): - -```shell -$ bundle install -``` - -A gulp file and package.json has been included if you'd rather run Browser Sync. If not, you can run Jekyll with it's built-in serve commands - -```shell -$ jekyll serve -``` - -Alghouth running `jekyll` commands through Bundler will ensure you're using the right versions: - -```shell -$ bundle exec jekyll serve -``` - -### Editing - -Jekyll Cart was optimized for CloudCannon but will run without it. If you plan to use the email checkout feature but aren't hosted with CloudCannon, you'll need some form system to do the sending. [Formspree](https://formspree.io/) is a good option. - -## License - -[Jekyll Cart](https://github.com/bradonomics/jekyll-cart/) is released under the [GPL-2.0 License](http://www.gnu.org/licenses/gpl-2.0.html). +--- -[Jekyll](http://jekyllrb.com/) is released under the MIT license. [simpleCart(js)](https://github.com/wojodesign/simplecart-js) is released under the MIT license and the [GPL-2.0 License](http://www.gnu.org/licenses/gpl-2.0.html). [Fur by CloudCannon](https://github.com/CloudCannon/fur-jekyll-template) is released under the MIT license. +## Deploy your own -> This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License, version 2, as -published by the Free Software Foundation. +Deploy your own Jekyll Cart project with Azion. -> This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/jekyll-cart "Deploy with Azion") -> You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/jekyll-ecommerce-collection/). \ No newline at end of file From aea1ea85b09da26b93f09d429ea8b6c813248d13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:37:27 -0300 Subject: [PATCH 21/76] refactor: update readme - Jekyll suply --- templates/jekyll/supply/README.md | 177 +++--------------------------- 1 file changed, 16 insertions(+), 161 deletions(-) diff --git a/templates/jekyll/supply/README.md b/templates/jekyll/supply/README.md index 11319fcc..0e3c43c3 100755 --- a/templates/jekyll/supply/README.md +++ b/templates/jekyll/supply/README.md @@ -1,177 +1,32 @@ -## Supply, an e-commerce Jekyll theme with Gumroad integration +# Jekyll Supply -[![Netlify Status](https://api.netlify.com/api/v1/badges/d0fa21a2-19fa-45da-a77a-024c58295e7f/deploy-status)](https://app.netlify.com/sites/supply-demo/deploys) +The **Jekyll Supply** template is a starter for building an e-commerce site using Supply, a Jekyll theme with Gumroad integration. It includes common features to display and sell your products, as well as options to customize the site. -Supply is an e-commerce template for [Jekyll](https://jekyllrb.com/) + [Gumroad](https://gumroad.com), designed with [Tachyons CSS](https://github.com/tachyons-css/tachyons). +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/jekyll-ecommerce-collection/). -If you are a Gumroad creator, you can use Supply with Jekyll to display and sell products on your site or blog. +This template uses Supply version `1.1.1`. -[Demo Site with documentation](https://supply.templates.supply) - -Browse through a live demo: [https://templates.supply](https://templates.supply). - -![Supply template screenshot](/images/screenshot.png) - -Supply is designed by [alternatyves](https://alternatyves.com/). - -Find more [templates, themes, and Jekyll tutorials](https://jekyllrb.com/resources/). +> **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 Jekyll Supply project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/jekyll-supply "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. --- -## Features - -- [x] List & display products, thanks to Jekyll's collections -- [x] Take payment online using [Gumroad](https://gumroad.com) -- [x] Contact form with [formcarry](https://www.formcarry.com) -- [x] Map with [Leaflet](https://leafletjs.com "Leaflet is the leading open-source JavaScript library for mobile-friendly interactive maps.") thanks to the [jekyll-leaflet plugin](https://github.com/DavidJVitale/jekyll-leaflet) -- [x] [jekyll-archives](https://github.com/jekyll/jekyll-archives) to build and sort through categories & tags pages -- [x] Custom variables -- [x] RSS/Atom feed -- [x] SEO tags -- [x] Microdata markup -- [x] Jekyll `livereload` + NPM for fast development -- [x] Built-in site search - -## Setup - -1. Install [Jekyll](https://jekyllrb.com/docs/installation/) -2. Add your site and author details in `_config.yml`. -3. Get a workflow going to see your site's output with Jekyll locally. - -*Supply* was built with [Jekyll](http://jekyllrb.com/) version 4.0.0 and should support newer versions as well. - -Install the dependencies with [Bundler](http://bundler.io/): - -~~~bash -$ bundle install -~~~ - -Run `jekyll` commands through Bundler to ensure you're using the right versions: - -~~~bash -$ bundle exec jekyll serve -~~~ - -### Config -Add your custom configuration in the ```_config``` file. - -### Navigation - -* Exposed as a data file to give clients better access -* Set in the *Data* / *Navigation* section, look for ```navigation.yml``` in ```_data```. - -### Footer -Look for ```footer.html``` in ```_includes``` to add and change your footer links. - -### Contact Page -To add you formcarry endpoint URL to `_config.yml`, you'll need a fromcarry account, please refer to [formcarry documentation](https://formcarry.com/documentation/getting-started) - -Add your map coordinates if you want to display a map. Please refer to the [jekyll-leaflet plugin](https://davidjvitale.com/tech/jekyll-leaflet/getting-started/) and [Leaflet](https://leafletjs.co - m) documentation for customizing your map(s). - -### Product Pages -If you have products on Gumroad, you can start adding product pages right away. Within the Supply theme, you'll find a sample of a product page with free products, ```free-products.html```, located in ```_pages```. - - -## Develop - -### Building front-end assets: styles and scripts - -4. Install Node module dependencies: - -~~~bash -npm install -~~~ - - -### Tachyons - -You can change the site styling using [Tachyons](http://tachyons.io), look for the CSS in the `sup-theme` file, located in the `src` folder. - -Tachyons is a CSS toolkit and design system based on using components. Please refer to [Tachyons documentation](http://tachyons.io/docs/), you can also start with [https://github.com/dwyl/learn-tachyons](https://github.com/dwyl/learn-tachyons) +## Deploy your own -Once you are done with your style changes, run: - -Run the npm run -~~~bash -build:css -~~~ - -That will process all your CSS files in one readable file located in `assets/css/sup-tachyons.css`. - -to minify your css you can run - -``` -npm run minify-css -``` - -or - -``` -npm run start -``` - -to minify and build the site locally. - - -### npm commands with browser reload - -Supply uses a couple of custom Postcss npm scripts. Make sure your dependencies are installed: `npm install`. Type `npm outdated` to see if you have outdated versions, then install any outdated dependencies. - -Once that is done, to build your site & concatenate your CSS (in `assets` -> `CSS`), simply run: - -``` -npm run start -``` - -This command builds the site locally on port 4000, you can quickly revise design changes thanks to `livereload`. - -## Editing - -### Posts - -* Add, update, or remove a post in the *Posts* collection. -* Change the defaults when new posts are created in `_posts/_defaults.md`. - -### Collections -To display products, Supply uses a collection called ```product``` -You will find a series of product samples in the `_products` collection folder. By design, all the products are on display on the home page, in Supply, that is `ìndex.html`. -You can manually create pages based on this index to [sort your products or any other collection by custom variable](/custom-variables/). - -You can also add your products in regular posts, using the Gumroad [overlay](/gumroad-overlay/), [embed](/gumroad-embed/), and [hyperlinks](/gumroad-hyperlink/) method, thanks to an include snippet. - -Write something like: - -```html -{% raw %} - -{% include gumroad-overlay.html id="supply" %}{% endraw %} -``` - -to get a product display like this: - - - -## Copyright / License -*Supply* is designed by [alternatyves](https://alternatyves.com/) and licensed under the [MIT license](https://github.com/YJPL/Supply/blob/master/LICENSE). - -[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/YJPL/Supply/pulls) - -Please use and [contribute to *Supply* ](https://github.com/YJPL/Supply/pulls). - -Buy Me A Coffee - -## Who is using this? +Deploy your own Jekyll Supply project with Azion. -- [x] [templates.supply](https://templates.supply) +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/jekyll-supply "Deploy with Azion") -Are you using Supply? [Let me know!](https://github.com/YJPL/supply/edit/master/README.md) +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/jekyll-ecommerce-collection/). \ No newline at end of file From ac478d281bea1c7b0b4ede8561aa74ef6d3a9910 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:52:08 -0300 Subject: [PATCH 22/76] refactor: update readme - Angular boilerplate --- .../angular/angular-boilerplate/README.md | 73 +++---------------- 1 file changed, 12 insertions(+), 61 deletions(-) diff --git a/templates/angular/angular-boilerplate/README.md b/templates/angular/angular-boilerplate/README.md index 5588b78e..46f250ab 100644 --- a/templates/angular/angular-boilerplate/README.md +++ b/templates/angular/angular-boilerplate/README.md @@ -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= -``` - -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/). \ No newline at end of file From 16752ddb1ce66aa1cbeeabcb98b17e5d2b29a5e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:07:33 -0300 Subject: [PATCH 23/76] refactor: update readme - Hugo Boilerplate --- templates/hugo/hugo-static/README.md | 67 +++++++--------------------- 1 file changed, 16 insertions(+), 51 deletions(-) diff --git a/templates/hugo/hugo-static/README.md b/templates/hugo/hugo-static/README.md index 9893ae4c..83227cb3 100644 --- a/templates/hugo/hugo-static/README.md +++ b/templates/hugo/hugo-static/README.md @@ -1,65 +1,30 @@ -# Hugo Static +# Hugo Boilerplate -This template provides a quickstart to deploy a [Hugo](https://gohugo.io) static website to the Azion edge platform. +With the **Hugo Boilerplate**, you can start a project using the Hugo framework and deploy it to the edge in a few steps. The template creates a GitHub repository containing your project, as well as an edge application and a domain to facilitate your access and management through Azion Edge Platform. -## Deploy Your Own +[Hugo](https://gohugo.io) is a fast and flexible static site generator written in Go. It allows users to create websites from plain text files using various markup formats, using a simple templating system that enables you to customize the look and feel of your site. It supports content management, multilingual sites, and various content types, being ideal for blogs, landing pages, documentation sites, portfolios, and more. -Deploy your own Hugo project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/hugo/hugo-boilerplate "Deploy with Azion") - -## Settings - -To successfully deploy this template, you must provide the information to configure your Azion application. Fields identified with an asterisk are mandatory. - - * **Application Name***: the name of your edge application on Azion. - * **GitHub Personal Token***: your GitHub personal token. - * While generating your GitHub personal token, grant that your scope has the permissions to authorize an OAuth app or a personal token to access to public and private repositories, including read and write access to code. You must also enable the workflow option to allow adding and updating GitHub Actions workflow files. - -Note that permissions can be scoped either to a user or an organization or to a repository. Read the [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) documentation for more information. - -After filling out the form, click the **Next** button to start the deployment process. +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 the Hugo Boilerplate](https://www.azion.com/en/documentation/products/guides/hugo-boilerplate/) guide. -Once the template is deployed, you can edit and update your args and code. However, you'll need to declare secrets on your project's GitHub repository first to complete the second build with these changes. When the second build is completed, you can manage your project with a [continuous deployment workflow](#continuous-deployment). +This template uses Hugo version `0.119.0`. -For a more detailed step-by-step on declaring your secrets and using this template, check the [How to deploy edge applications with the Next.js Static Boilerplate](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) guide for more details. +--- -## Important +## Requirements -To guarantee the optimal performance of this template, it's necessary to activate the following Azion product: +Before using this template, you need to: -* [Edge Functions](https://www.azion.com/en/documentation/products/edge-application/edge-functions/#edge-functions-management) +- 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. -You need to activate the product separately via RTM. Review the [Azion documentation](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) to do so. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. -If this product is activated, the execution of this template could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. +--- -## Continuous deployment +## Deploy your own -Once the template is deployed, you can edit it and update it, 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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: edge-... - id: azion_edge - ... - with: - .... - azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }} - .... - -``` +Deploy your own Hugo project with Azion. -3. Open a pull request to merge the changes to the main branch and start the automatic deployment. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/hugo/hugo-boilerplate "Deploy with Azion") -Now your project is ready to work with a continuous deployment workflow, updating instantly any changes in the application or the repository. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/hugo-boilerplate/). From 46fe5635bbc976e4c90fc98a4e1e5efe90c4bf9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:23:06 -0300 Subject: [PATCH 24/76] refactor: update readme - Influencer + Vex Hugo --- templates/hugo/influencer-hugo/README.md | 126 +++----------------- templates/hugo/vex-hugo/README.md | 145 +++-------------------- 2 files changed, 33 insertions(+), 238 deletions(-) diff --git a/templates/hugo/influencer-hugo/README.md b/templates/hugo/influencer-hugo/README.md index 9099fdbb..f2e61147 100644 --- a/templates/hugo/influencer-hugo/README.md +++ b/templates/hugo/influencer-hugo/README.md @@ -1,126 +1,32 @@ -

Influencer Hugo

-

Influencer is a modern and elegant crafted responsive Hugo theme for book authors and writer

-

👀Demo | Page Speed (95%)🚀

+# Influencer Hugo -## Deploy Your Own +The **Influencer Hugo** template provides a quick option to create an e-commerce website based on the Hugo framework. Even when the theme is designed for book authors and writers, it can be customized to showcase any type of product. -Deploy your own Influencer Hugo project with Azion. +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 an e-commerce based on Hugo using templates](https://www.azion.com/en/documentation/products/guides/hugo-ecommerce-collection/) guide. -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/influencer-hugo "Deploy with Azion") +This template uses min-Hugo version `0.62.0`. +> **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. --- +## Requirements -

- - - - - - license - - code size +Before using this template, you need to: - - contributors +- 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. - - follow on Twitter -

+> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. --- -

- screenshot -

- ---- -## 🔑Key Features - -- 📊 Google Analytics support -- 📄 Onepage template -- 🎨 CSS and JS bundle with Hugo Pipe -- 🅱️ Bootstrap Based -- ⚙️ Netlify settings predefined -- 🔄 GDPR consent enabled -- 🚀 Google Page Speed optimized -- 🌐 Open Graph meta tag -- 🐦 Twitter Card meta tag - - -## 🔧Local development - -```bash -# clone the repository -git clone git@github.com:gethugothemes/influencer-hugo.git - -# cd in the project directory -$ cd influencer-hugo/exampleSite/ - -# Start local dev server -$ hugo server --themesDir ../.. -``` -Or Check out [Full Documentation](https://docs.gethugothemes.com/influencer/?ref=github). - - -## ⚙️Deployment and hosting - -[![Deploy to -Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gethugothemes/influencer-hugo) - -Follow the steps. +## Deploy your own - -## 🐞Reporting Issues -We use GitHub Issues as the official bug tracker for the influencer Template. Please Search [existing -issues](https://github.com/gethugothemes/influencer-hugo/issues). Someone may have already reported the same problem. -If your problem or idea has not been addressed yet, feel free to [open a new -issue](https://github.com/gethugothemes/influencer-hugo/issues). - -## 📱Submit Your Website To Our Showcase - -Are you using Influencer Hugo theme? Submit it to our [showcase](https://gethugothemes.com/showcase). - -Our showcase aims to demonstrate to the world what amazing websites people like you have created utilizing our Hugo themes and to show that Hugo has tremendous capabilities as a Static Site Generator. - -View all the websites powered by Influencer Hugo from [here](https://gethugothemes.com/showcase?theme=influencer). - -[Submit](https://gethugothemes.com/showcase?submit=show) your Influencer Hugo powered website. - - - - -## 📄License -Copyright © Designed by [Themefisher](https://themefisher.com) & Developed by -[Gethugothemes](https://gethugothemes.com) - -**Code License:** Released under the [MIT](https://github.com/gethugothemes/influencer-hugo/blob/master/LICENSE) license. - -**Image license:** The images are only for demonstration purposes. They have their licenses. We don't have permission to -share those images. - - -## 🙏Special Thanks -- [Bootstrap](https://getbootstrap.com) -- [Jquery](https://jquery.com) -- [Themify Icons](https://themify.me/themify-icons) -- [Magnific Popup](https://dimsemenov.com/plugins/magnific-popup/) -- [Slick Slider](https://kenwheeler.github.io/slic/) -- [Google Fonts](https://fonts.google.com/) -- [All Contributors](https://github.com/gethugothemes/influencer-hugo/graphs/contributors) - - -## 👨‍💻Hire Us -Besides developing unique, blazing-fast Hugo themes, we also provide customized services. We specialize in creating affordable, high-quality static websites based on Hugo. +Deploy your own Influencer Hugo project with Azion. -If you need to customize the theme or complete website development from scratch, you can hire us. **Check Our -[services](https://gethugothemes.com/services/?utm_source=influencer_github&utm_medium=referral&utm_campaign=github_theme_readme)** +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/influencer-hugo "Deploy with Azion") - -## 💎Premium Themes By Us -| [![Mega-Bundle-HUGO](https://demo.gethugothemes.com/thumbnails/bundle.png?)](https://gethugothemes.com/bundle/?utm_source=influencer_github&utm_medium=referral&utm_campaign=github_theme_readme) | [![Hargo](https://demo.gethugothemes.com/thumbnails/hargo.png)](https://gethugothemes.com/products/hargo/) | [![Logbook](https://demo.gethugothemes.com/thumbnails/logbook.png)](https://gethugothemes.com/products/logbook) | -|:---:|:---:|:---:| -| **Get 55+ Premium Hugo Themes Bundle** | **Hargo** | **Logbook** | +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/hugo-ecommerce-collection/). diff --git a/templates/hugo/vex-hugo/README.md b/templates/hugo/vex-hugo/README.md index d387175b..f7d53d65 100644 --- a/templates/hugo/vex-hugo/README.md +++ b/templates/hugo/vex-hugo/README.md @@ -1,143 +1,32 @@ -

Vex Hugo

-

Vex is a clean multipurpose e-commerce theme that makes building your first online store easier than ever.

-

👀Demo | Page Speed (97%)🚀

+# Vex Hugo -## Deploy Your Own +The **Vex Hugo** template is a product landing page Hugo theme. It's fully responsive and crafted with Product Showcase, Testimonials, and Email Subscription sections. The deployment will create a new edge application with its configurations, which you can edit and manage later. It also creates a repository in your GitHub account, based on the template, allowing you to maintain control over the project. -Deploy your own Vex Hugo project with Azion. +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 an e-commerce based on Hugo using templates](https://www.azion.com/en/documentation/products/guides/hugo-ecommerce-collection/) guide. -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/vex-hugo "Deploy with Azion") +This template uses min-Hugo version `0.62.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. --- -

- - - - - - license - - code size - - - contributors - - - follow on Twitter -

- - - -

- screenshot -

- - - -## 🔑Key Features - -- 📄 10+ Pre-Designed Pages -- 🌍 Multiple language support (Fr, En) -- 📊 Google Analytics support -- 🎨 CSS and JS bundle with Hugo Pipe -- ⚙️ Netlify settings predefine -- 🅱️ Bootstrap Based -- ✉️ Contact form support -- 📧 Mailchimp integration -- 🚀 Google Page Speed optimized -- 🌐 Open Graph meta tag -- 🐦 Twitter Card meta tag - -## 📄 10+ Pre-Designed Pages - -- 🏠 Home Page -- 📄 Product Page -- 📝 Product Single Page -- 🛒 Cart Page -- 💳 Checkout Page -- 📚 Blog Page -- 📝 Blog Single Page -- 🔒 Privacy Page -- 📞 Contact Page -- 🔒 Terms and Condition Page - - - - -## 🔧Local development - -```bash -# clone the repository -git clone git@github.com:themefisher/vex-hugo.git +## Requirements -# cd in the project directory -$ cd vex-hugo/exampleSite/ +Before using this template, you need to: -# Start local dev server -$ hugo server --themesDir ../.. -``` +- 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. -Or Check out [Full Documentation](https://docs.gethugothemes.com/vex/?ref=github). +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. +--- -## ⚙️Deployment and hosting - -[![Deploy to -Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/themefisher/vex-hugo) - -Follow the steps. - - -## 🐞Reporting Issues - -We use GitHub Issues as the official bug tracker for the Vex Template. Please Search [existing -issues](https://github.com/themefisher/vex-hugo/issues). Someone may have already reported the same problem. -If your problem or idea has not been addressed yet, feel free to [open a new -issue](https://github.com/themefisher/vex-hugo/issues). - -## 📱Submit Your Website To Our Showcase - -Are you using Vex Hugo theme? Submit it to our [showcase](https://gethugothemes.com/showcase). - -Our showcase aims to demonstrate to the world what amazing websites people like you have created utilizing our Hugo themes and to show that Hugo has tremendous capabilities as a Static Site Generator. - -View all the websites powered by Vex Hugo from [here](https://gethugothemes.com/showcase?theme=vex). - -[Submit](https://gethugothemes.com/showcase?submit=show) your Vex Hugo powered website. - - -## 📄License - -Copyright © Designed by [Themefisher](https://themefisher.com) & Developed by -[Gethugothemes](https://gethugothemes.com) - -**Code License:** Released under the [MIT](https://github.com/themefisher/vex-hugo/blob/master/LICENSE) license. - -**Image license:** The images are only for demonstration purposes. They have their licenses. We don't have permission to -share those images. - - -## 🙏Special Thanks - -- [Bootstrap](https://getbootstrap.com) -- [Jquery](https://jquery.com) -- [Slick Slider](https://kenwheeler.github.io/slick/) -- [Google Fonts](https://fonts.google.com/) -- [All Contributors](https://github.com/themefisher/vex-hugo/graphs/contributors) - -## 👨‍💻Hire Us - -Besides developing unique, blazing-fast Hugo themes, we also provide customized services. We specialize in creating affordable, high-quality static websites based on Hugo. +## Deploy your own -If you need to customize the theme or complete website development from scratch, you can hire us. **Check Our -[Services](https://gethugothemes.com/services/?utm_source=vex_github&utm_medium=referral&utm_campaign=github_theme_readme)** +Deploy your own Vex Hugo project with Azion. - -## 💎Premium Themes By Us +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/vex-hugo "Deploy with Azion") -| [![Mega-Bundle-HUGO](https://demo.gethugothemes.com/thumbnails/bundle.png?)](https://gethugothemes.com/bundle/?utm_source=vex_github&utm_medium=referral&utm_campaign=github_theme_readme) | [![Hargo](https://demo.gethugothemes.com/thumbnails/hargo.png)](https://gethugothemes.com/products/hargo/) | [![Loogbook](https://demo.gethugothemes.com/thumbnails/logbook.png)](https://gethugothemes.com/products/logbook/) | -|:---:|:---:|:---:| -| **Get 55+ Premium Hugo Themes Bundle** | **Hargo** | **logbook** | +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/hugo-ecommerce-collection/). \ No newline at end of file From d28e2c7d6dccc27cb7d5e5929f006c1ea469c5c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:29:23 -0300 Subject: [PATCH 25/76] refactor: update readme - hexo boilerplate --- templates/hexo/hexo-boilerplate/README.md | 89 ++++------------------- 1 file changed, 13 insertions(+), 76 deletions(-) diff --git a/templates/hexo/hexo-boilerplate/README.md b/templates/hexo/hexo-boilerplate/README.md index 8b1599de..a68f61dc 100644 --- a/templates/hexo/hexo-boilerplate/README.md +++ b/templates/hexo/hexo-boilerplate/README.md @@ -1,91 +1,28 @@ # Hexo Boilerplate -The Azion **Hexo Boilerplate** is designed to simplify and enhance the deployment process for Hexo applications directly on the edge of the network. +The **Hexo Boilerplate** facilitates you to build and run a Hexo Single-Page Application (SPA) directly on the edge, completing several steps, from repository management to edge deployment, through automation. -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 Hexo Boilerplate](https://www.azion.com/en/documentation/products/guides/hexo-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 Hexo Boilerplate](https://www.azion.com/en/documentation/products/guides/hexo-boilerplate/) guide. This template uses Hexo version `6.3.0`. -## Deploy Your Own +--- -Deploy your own Hexo project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/hexo/hexo-boilerplate "Deploy with Azion") - - -## Usage Information - -To start using this template, you need to: - -1. Access [Azion Real-Time Manager (RTM)](https://manager.azion.com/). - - If you don’t have an account yet, create a new one [by visiting the sign-up page](https://manager.azion.com/signup/). -2. On the homepage, select the **Start with a template** option. -3. Find the **Hexo boilerplate** card and select it. -4. Click the **Settings tab** to configure the template. - -## Settings - -To successfully deploy this template, you must provide the information to configure your Azion application. Fields identified with an asterisk are mandatory. - - * **Application Name***: the name of your edge application on Azion. - * **GitHub Personal Token***: your GitHub personal token. - * While generating your GitHub personal token, grant that your scope has the permissions to authorize an OAuth app or a personal token to access to public and private repositories, including read and write access to code. You must also enable the workflow option to allow adding and updating GitHub Actions workflow files. - -Note that permissions can be scoped either to a user or an organization or to a repository. Read the [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) documentation for more information. - -After filling out the form, click the **Next** button to start the deployment process. - -Once the template is deployed, you can edit and update your args and code. However, you'll need to declare secrets on your project's GitHub repository first to complete the second build with these changes. When the second build is completed, you can manage your project with a [continuous deployment workflow](#continuous-deployment). - -For a more detailed step-by-step on declaring your secrets and using this template, check the [How to deploy edge applications with the Hexo Boilerplate](https://www.azion.com/en/documentation/products/guides/hexo-boilerplate/) guide for more details. - -## Important +## Requirements -To guarantee the optimal performance of this template, it's necessary to activate the following Azion product: +Before using this template, you need to: -* [Edge Functions](https://www.azion.com/en/documentation/products/edge-application/edge-functions/#edge-functions-management) +- 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. -You need to activate the product separately via RTM. Review the [Azion documentation](https://www.azion.com/en/documentation/products/guides/hexo-boilerplate/) to do so. +> **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. -If this product is activated, the execution of this template could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. +--- -## Continuous deployment +## Deploy your own -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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - -## 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 Real-Time Manager (RTM)](https://manager.azion.com/). - -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 Hexo 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/edge-application/domains/) documentation to read more about it. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/hexo/hexo-boilerplate "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/hexo-boilerplate/). From dea31e618109951c093d5ac2afd871f800695264 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Thu, 24 Oct 2024 12:13:12 -0300 Subject: [PATCH 26/76] refactor: update readmes - Docusaurus JS, TS and Material --- .../docusaurus-boilerplate-js/README.md | 50 +++++---------- .../docusaurus-boilerplate-ts/README.md | 49 +++++---------- .../docusaurus-material-ui-template/README.md | 63 ++++++------------- 3 files changed, 51 insertions(+), 111 deletions(-) diff --git a/templates/docusaurus/docusaurus-boilerplate-js/README.md b/templates/docusaurus/docusaurus-boilerplate-js/README.md index 88f49a42..580ae767 100644 --- a/templates/docusaurus/docusaurus-boilerplate-js/README.md +++ b/templates/docusaurus/docusaurus-boilerplate-js/README.md @@ -1,48 +1,30 @@ -# Website +# Docusaurus JavaScript Boilerplate -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +**Docusaurus JavaScript Boilerplate** is a starter example to deploy a basic static project based on the Docusaurus framework and written in JavaScript. -### Deploy Your Own +[Docusaurus](https://docusaurus.io/) is a static-site generator, building a single-page application with fast client-side navigation and leveraging React to make the site interactive. It's ideal for documentation features and other cases, including website, product pages, blog, and landing pages. -Deploy your own Docusaurus project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/docusaurus/docusaurus-boilerplate-javascript "Deploy with Azion") - - -### Installation +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 the Docusaurus JavaScript Boilerplate](https://www.azion.com/en/documentation/products/guides/docusaurus-javascript-boilerplate/) guide. -``` -$ yarn -``` +This template uses Docusaurus version `3.4.0`. -### Local Development +--- -``` -$ yarn start -``` +## Requirements -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +Before using this template, you need to: -### Build +- 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. -``` -$ yarn build -``` +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. -This command generates static content into the `build` directory and can be served using any static contents hosting service. +--- -### Deployment +## Deploy your own -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: +Deploy your own Docusaurus project with Azion. -``` -$ GIT_USER= yarn deploy -``` +[![Deploy Button](/static/button.png)](https://console.azion.com/create/docusaurus/docusaurus-boilerplate-javascript "Deploy with Azion") -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/docusaurus-javascript-boilerplate/). \ No newline at end of file diff --git a/templates/docusaurus/docusaurus-boilerplate-ts/README.md b/templates/docusaurus/docusaurus-boilerplate-ts/README.md index 0d3d0642..fe4e3b21 100644 --- a/templates/docusaurus/docusaurus-boilerplate-ts/README.md +++ b/templates/docusaurus/docusaurus-boilerplate-ts/README.md @@ -1,47 +1,30 @@ -# Website +# Docusaurus TypeScript Boilerplate -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +**Docusaurus TypeScript Boilerplate** is a starter example to deploy a basic static project based on the Docusaurus framework and written in TypeScript. -### Deploy Your Own +[Docusaurus](https://docusaurus.io/) is a static-site generator, building a single-page application with fast client-side navigation and leveraging React to make the site interactive. It's ideal for documentation features and other cases, including website, product pages, blog, and landing pages. -Deploy your own Docusaurus project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/docusaurus/docusaurus-boilerplate-typescript "Deploy with Azion") - -### Installation +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 the Docusaurus TypeScript Boilerplate](https://www.azion.com/en/documentation/products/guides/docusaurus-typescript-boilerplate/) guide. -``` -$ yarn -``` +This template uses Docusaurus version `3.4.0`. -### Local Development +--- -``` -$ yarn start -``` +## Requirements -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +Before using this template, you need to: -### Build +- 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. -``` -$ yarn build -``` +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. -This command generates static content into the `build` directory and can be served using any static contents hosting service. +--- -### Deployment +## Deploy your own -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: +Deploy your own Docusaurus project with Azion. -``` -$ GIT_USER= yarn deploy -``` +[![Deploy Button](/static/button.png)](https://console.azion.com/create/docusaurus/docusaurus-boilerplate-typescript "Deploy with Azion") -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/docusaurus-typescript-boilerplate/). diff --git a/templates/docusaurus/docusaurus-material-ui-template/README.md b/templates/docusaurus/docusaurus-material-ui-template/README.md index 3a8ec5bf..f3bd01f4 100644 --- a/templates/docusaurus/docusaurus-material-ui-template/README.md +++ b/templates/docusaurus/docusaurus-material-ui-template/README.md @@ -1,59 +1,34 @@ -# Integrating Docusaurus with Material UI Template +# Docusaurus with Material UI -This project is a Docusaurus website integrated with Material UI. Docusaurus is a modern static website generator that makes it easy to build personal, project, and organization sites. Material UI is a popular React UI framework that provides a set of reusable, well-tested, and accessible UI components. +Docusaurus is a static-site generator while Material UI is a popular React UI framework that provides reusable UI components. The **Docusaurus with Material UI** template allows you to deploy, directly on the edge, a Docusaurus website integrated with Material UI. -## Deploy Your Own +Docusarius-based templates are ideal for documentation features and other cases, including website, product pages, blog, and landing pages. The deployment of this template creates a GitHub repository containing your project, as well as an edge application and a domain to facilitate your access and management through Azion Edge Platform. -Deploy your own Docusaurus project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/docusaurus/docusaurus-material-ui "Deploy with Azion") - -## Technology used - -- Docusaurus V3 -- Material UI -- Search engine: `@easyops-cn/docusaurus-search-local` - -## Features - -The project uses the [@easyops-cn/docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local) plugin for local search functionality. This plugin provides full-text search over your Docusaurus site, without needing to rely on any external services. It supports indexing of pages and documents, and even supports language-specific searching. +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 the Docusaurus with Material UI template](https://www.azion.com/en/documentation/products/guides/docusaurus-material-ui-template/) guide. -The website also features a new blog UI was built using Material UI components and provides a modern, clean interface for displaying blog posts. The blog posts are managed by a custom blog plugin, defined in `src/plugins/blog-plugin.js` and homepage config in `components/Homepage/index.js`. +This template uses Docusaurus version `3.3.2`. -## Start your project +> **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 on Vercel +--- -You can get started by creating your own Docusaurus website and deploy to Vercel by clicking the link: +## Requirements -[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fnamnguyenthanhwork%2Fdocusaurus-material-ui-template&showOptionalTeamCreation=false) +Before using this template, you need to: -Vercel will copy the [Docusaurus Material UI](https://github.com/namnguyenthanhwork/docusaurus-material-ui-template) and deploy the website for you. Once completed, every commit in the repo will be deployed automatically. +- 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. -### Installation +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. -Clone the [repository](https://github.com/namnguyenthanhwork/docusaurus-material-ui-template) +--- -Open project and install packages +## Deploy your own -``` -npm i -``` - -### Ready to use - -Start the development server - -``` -npm start -``` - -Build the project - -``` -npm run build -``` +Deploy your own Docusaurus project with Azion. -## Contributing to the project +[![Deploy Button](/static/button.png)](https://console.azion.com/create/docusaurus/docusaurus-material-ui "Deploy with Azion") -Create a new Pull Request to contribute to the project. If you find any issues or have suggestions for improvements, please create a new issue. Thanks for any feedback! \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/docusaurus-material-ui-template/). \ No newline at end of file From 3505c996d0f9dd4ec2d95401df0814b4b1195399 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Thu, 24 Oct 2024 12:29:07 -0300 Subject: [PATCH 27/76] refactor: uppdate readme - mongodb atlas --- templates/typescript/azion-atlas/README.md | 70 ++++------------------ 1 file changed, 10 insertions(+), 60 deletions(-) diff --git a/templates/typescript/azion-atlas/README.md b/templates/typescript/azion-atlas/README.md index 7cb9f5c8..1370116c 100644 --- a/templates/typescript/azion-atlas/README.md +++ b/templates/typescript/azion-atlas/README.md @@ -1,79 +1,29 @@ # MongoDB Atlas Boilerplate -The **MongoDB Atlas Boilerplate** allows you to deploy an application integrated with MongoDB Atlas on the edge. Besides, due to the integration with the Atlas Data API, you’re able to create, retrieve, update, and delete items in your collections through standard HTTPS requests. +The **MongoDB Atlas Boilerplate** allows you to deploy an application integrated with MongoDB Atlas on the edge. Besides, thanks to the integration with the Atlas Data API, you're able to create, retrieve, update, and delete items in your collections through standard HTTPS requests. 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 the MongoDB Atlas Boilerplate](https://www.azion.com/en/documentation/products/guides/mongodb-atlas/) guide. --- -## Deploy Your Own - -Deploy your own MongoDB Atlas project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/mongodb-atlas/mongodb-atlas "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 the MongoDB Atlas Boilerplate](https://www.azion.com/en/documentation/products/guides/mongodb-atlas/) guide. - -### Requirements +## Requirements - Create a [MongoDB account](https://www.mongodb.com/cloud/atlas/register). - Create a [cluster](https://www.mongodb.com/docs/atlas/create-database-deployment/) and add a new database. - Create a collection to be used with this template. - Active the service [Atlas Data API](https://www.mongodb.com/docs/atlas/app-services/data-api/). -Generate API key in [Atlas Service](https://www.mongodb.com/docs/atlas/app-services/authentication/api-key/#std-label-api-key-authentication). -- 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 Application Accelerator](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. - ---- +- Generate API key in [Atlas Service](https://www.mongodb.com/docs/atlas/app-services/authentication/api-key/#std-label-api-key-authentication). +- 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. -## 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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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 [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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 +## Deploy your own -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/). - -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 MongoDB Atlas project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/mongodb-atlas/mongodb-atlas "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 on using this template, check the [How to deploy the MongoDB Atlas Boilerplate](https://www.azion.com/en/documentation/products/guides/mongodb-atlas/) guide. You can also learn how to deploy this template by watching [this video](https://www.youtube.com/watch?v=pKv8c0RNbGY&list=PL02NW2s3y10OR8Vw4hsth3TLw4R7VE094&index=6&pp=iAQB) on Azion's YouTube channel. \ No newline at end of file From bc94ed3c1d4287a7125919bb1e9d1ca686193d9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Thu, 24 Oct 2024 13:58:33 -0300 Subject: [PATCH 28/76] refactor: update readme - Gastby Boilerplate, Blog, Ecommerce --- templates/gatsby/gatsby-blog/README.md | 67 +----- templates/gatsby/gatsby-boilerplate/README.md | 66 +----- .../gatsby/gatsby-ecommerce-theme/README.md | 195 ++---------------- 3 files changed, 34 insertions(+), 294 deletions(-) diff --git a/templates/gatsby/gatsby-blog/README.md b/templates/gatsby/gatsby-blog/README.md index 257b5284..4f4c2b83 100644 --- a/templates/gatsby/gatsby-blog/README.md +++ b/templates/gatsby/gatsby-blog/README.md @@ -8,70 +8,21 @@ The Gatsby Blog Starter Kit uses Gatsby version `5.13.2` and React version `18.2 --- -## Deploy Your Own +## Requirements -Deploy your own Gatsby project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/gatsby/gatsby-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 must 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 a blog based on Gatsby using a template](https://www.azion.com/en/documentation/products/guides/gatsby-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](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= -``` - -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 [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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 Gatsby 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/gatsby/gatsby-blog-starter-kit "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/gatsby-blog-starter-kit/). \ No newline at end of file diff --git a/templates/gatsby/gatsby-boilerplate/README.md b/templates/gatsby/gatsby-boilerplate/README.md index 907396b2..645a5bd5 100644 --- a/templates/gatsby/gatsby-boilerplate/README.md +++ b/templates/gatsby/gatsby-boilerplate/README.md @@ -8,69 +8,21 @@ The Gatsby Boilerplate uses Gatsby version `5.13.3` and React version `18.2.0`. --- -## Deploy Your Own +## Requirements -Deploy your own Gatsby project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/gatsby/gatsby-boilerplate "Deploy with Azion") - ---- - -## Usage information - -To use this template, you must [sign in on Azion Console](https://console.azion.com/login). +Before using this template, you need to: -> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration. +- 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. -To successfully deploy this template, you must 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 Gatsby Boilerplate](https://www.azion.com/en/documentation/guides/gatsby-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 and Application Accelerator](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. --- -## 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. +## Deploy your own -```bash - AZION_PERSONAL_TOKEN= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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/). - -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 Gatsby project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/gatsby/gatsby-boilerplate "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/guides/gatsby-boilerplate/). \ No newline at end of file diff --git a/templates/gatsby/gatsby-ecommerce-theme/README.md b/templates/gatsby/gatsby-ecommerce-theme/README.md index 224d829a..4c2f157c 100644 --- a/templates/gatsby/gatsby-ecommerce-theme/README.md +++ b/templates/gatsby/gatsby-ecommerce-theme/README.md @@ -1,195 +1,32 @@ -![Gatsby E-commerce theme designed by Matter](https://user-images.githubusercontent.com/43764894/223762927-2e463570-b09a-4d51-ab81-2e0fa8aa2c70.png) +# Gatsby Ecommerce Theme -This beautiful theme from the [Matter Design Team](https://matterdesign.com.au/) gives you the styling and scaffolding for your next e-commerce site. You can customize to your heart's content and add the tooling for cart, transactions, product, and more. This theme uses: +The **Gatsby E-commerce Theme** template enables you to deploy a Gatsby-based e-commerce site in a few steps, directly to the edge. It includes styled components and tools to add functionality, streamlining the customization process. -- [Gatsby](https://www.gatsbyjs.com/) -- [CSS Modules](https://github.com/css-modules/css-modules) -- [Prettier](https://prettier.io/) -- [React Helmet](https://github.com/nfl/react-helmet) +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 an e-commerce using the Gatsby E-commerce Theme template](https://www.azion.com/en/documentation/products/guides/gatsby-ecommerce-theme/) guide. -Take a look at the screenshot below or preview the live site here: https://gatsby-ecommerce-theme.netlify.app/! -![full page screenshot](https://res.cloudinary.com/dzkoxrsdj/image/upload/v1653371030/CleanShot_2022-05-24_at_01.11.52_2x_bspa8c.jpg) +This template uses Gatsby version `5.13.3`. -> 🧐 Please be aware that some aspects of this theme are not fully functional and will need to be integrated with the recommended tooling mentioned at the end of the [README](#next-steps-with-this-theme). +> **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 Gatsby Ecommerce Theme project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/gatsby/gatsby-ecommerce-theme "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. --- -## Table of Contents: - -- [Quick Steps + Deploy Options](#quick-setup--deploy-option) - - [Cloning + Installing Packages](#cloning--installing-packages) -- [Deploying](#deploying) -- [Project Structure](#project-structure) - - [Making Changes to the Hero Component](#making-changes-to-the-hero-component) - - [Making Changes to the Header or Footer](#making-content-changes-to-the-header-or-footer) -- [Testing](#testing) - - [Included Default Testing](#included-default-testing) - - [Removing Renovate](#removing-renovate) -- [Next Steps with This Theme](#next-steps-with-this-theme) - -## Quick Setup + Deploy Option - -Click the button below and it will help you create a new repo, create a new Netlify project, and deploy this Theme! - -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/gatsby-ecommerce-theme&utm_source=github&utm_medium=matter-design-theme-repo&utm_campaign=template-team) - -## Regular Setup - - ### Cloning + Installing Packages - - - Clone this repo with one of these options: - - - Click the 'Use this template' button at the top of the page - - Via the command line: - ```shell - git clone https://github.com/netlify-templates/gatsby-ecommerce-theme/ - ``` - - Or you can clone the theme straight from the Netlify CLI, using the `netlify sites:create-template` command in your terminal ([learn more about this command here](https://www.netlify.com/blog/create-a-site-from-a-template-using-the-netlify-cli)) to do the entire flow for you. - - From there, you can install the project's dependencies by running: - - ```shell - npm install or yarn install - ``` - - Finally, you can run your project locally with: - - ```shell - cd gatsby-sydney-ecommerce-theme/ - npm start or yarn start - ``` - - or, run it using the Netlify CLI with: - - ```shell - netlify run dev - ``` - - Open your browser and visit , your project should now be running! - - ## Deploying - - After installing and customizing your new e-commerce theme it's now time to deploy! - - - You can Deploy using the [Netlify CLI](https://cli.netlify.com/): - - ```bash - netlify init # initialize a new Netlify project & deploy - ``` - - It will use the information from the included Netlify configuration file, [`netlify.toml`](./netlify.toml), to set up the build command as `gatsby build` to create a static project and locate the build project in the `public` directory. - - The `init` process will also set up continuous deployment for your project so that a new build will be triggered & deployed when you push code to the repo (you can change this from your project dashboard: Site Settings/Build & deploy/Continuous Deployment). - - You can also use `netlify deploy (--prod)` to manually deploy and `netlify open` to open your project dashboard. - - > 💡 we only have so many keystrokes to give, use `ntl` shorthand for `netlify` or make [an alias of your own](https://www.netlify.com/blog/2020/04/12/speed-up-productivity-with-terminal-aliases/) to save hours...of accumulated milliseconds - - - You can deploy within the Netlify site by connecting to git, this [video](https://www.youtube.com/watch?v=4h8B080Mv4U&t=107s) will walk you through that process. - - Or, you can use the Deploy to Netlify button which will walk you through the process of spinning up a repo, creating a new project in Netlify, AND deploying it :) - -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/gatsby-ecommerce-theme&utm_source=github&utm_medium=matter-design-theme-repo&utm_campaign=template-team) - -## Project Structure +## Deploy your own -Here is a bit of an overview of the directory structure of the project: - -| Directory | Description | -| :---- | :---- | -| `src/components/` | Stores reusable elements across the site. (e.g. BlogPreview element) | -| `src/pages/` | Stores routes for a user to go to based on each `.js` file and nested folder (e.g. `src/pages/about.js` creates a route `/about` in the web app) | -| `src/helpers` | Stores mock data for the blog or product list and general utility functions. | - -### Making changes to the Hero component - -On the homepage of the website and a few other places, there is a full-width image component. We refer to this as the `` component. Here is a bit of an overview of what its API looks like: - -```jsx - -``` - -You can see it in action under [`src/pages/index.js`](./src/pages/index.js) or see the component in [`src/components/Hero/Hero.js`](./src/components/Hero/Hero.js). - -### Making content changes to the Header or Footer - -The project contains a file named `src/config.json`. Inside of this file describes the content of the header links (`headerLinks`) as well as the footer links (`footerLinks`). For the header, each element in the array has a base structure of: - -```json -{ - "menuLabel": "The label that is given to a user", - "menuLink": "The URL that this should take a user to" -} -``` - -If you want the menu item to have a dropdown, you can also add a `category` key with the value being an array of the categories and their containing elements, here's what the base could look like: - -```json -{ - "menuLabel": "The label that is given to a user", - "menuLink": "The URL that this should take a user to", - "category": [ - { - "categoryLabel": "Label you want the category to have", - "submenu": [ - { - "menuLabel": "A label underneath the category", - "menuLink": "The associated link to this label" - } - ] - } - ] -} -``` - -The footer works in a similar way. It assumes each element in the array has a heading and an array of associated links to direct folks to: - -```json -"footerLinks": [ - { - "subTitle": "Label of the column in the footer", - "links": [ - { - "text": "Text to display to the user", - "link": "URL of where to take the user to when clicked" - }, - ] - } -] -``` - -## Testing - -### Included Default Testing - -We’ve included some tooling that helps us maintain these templates. This template currently uses: - -- [Renovate](https://www.mend.io/free-developer-tools/renovate/) - to regularly update our dependencies - -If your team is not interested in this tooling, you can remove them with ease! - -### Removing Renovate - -In order to keep our project up-to-date with dependencies we use a tool called [Renovate](https://github.com/marketplace/renovate). If you’re not interested in this tooling, delete the `renovate.json` file and commit that onto your main branch. +Deploy your own Gatsby Ecommerce Theme project with Azion. -## Next Steps with this theme +[![Deploy Button](/static/button.png)](https://console.azion.com/create/gatsby/gatsby-ecommerce-theme "Deploy with Azion") -This project is intended to be extended by you! We wanted to make possible to replace parts of it with your own tools and data sources. If you're interested on a direction, you can refer to Matter's [how to use section](https://gatsby-ecommerce-theme.netlify.app/how-to-use/) in this project or you may want to consider using [Matter's toolset with their JAMM framework](https://matterdesign.com.au/service/headless-commerce-with-jamm/) which includes some projects like: -- [BigCommerce](https://bigcommerce.zfrcsk.net/c/2429593/854992/2941) for a headless e-commerce solution -- [Builder](https://www.builder.io) as a CMS for the blog articles or other content creation -- [Klaviyo](https://www.klaviyo.com/) for any email or SMS marketing automation +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/gatsby-ecommerce-theme/). \ No newline at end of file From 280c66047864c3db93e07b9937ea3413e50f6309 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:19:48 -0300 Subject: [PATCH 29/76] refactor: update Azion Edge SQL --- templates/javascript/azion-edge-sql/README.md | 61 ++----------------- 1 file changed, 6 insertions(+), 55 deletions(-) diff --git a/templates/javascript/azion-edge-sql/README.md b/templates/javascript/azion-edge-sql/README.md index d7849501..58e1e69b 100644 --- a/templates/javascript/azion-edge-sql/README.md +++ b/templates/javascript/azion-edge-sql/README.md @@ -2,64 +2,15 @@ The **Azion Edge SQL** accelerates the integration of a Azion edge SQL database into an edge function. It also provides an interface to easily create, update, and delete items in your database. -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 integrate a Azion Edge SQL database with Azion using a template](https://www.azion.com/en/documentation/products/guides/azion-edge-sql/) 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 integrate an Azion Edge SQL database with Azion using a template](https://www.azion.com/en/documentation/products/guides/azion-edge-sql/) guide. --- -## Usage information +## Requirements -To use this template, you must [sign in on Azion Console](https://console.azion.com/login). +Before using this template, you need to: -> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration. +- 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. -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 integrate a Azion Edge SQL database with Azion using a template](https://www.azion.com/en/documentation/products/guides/azion-edge-sql/) guide. - -### Requirements - -- Enable [Edge Functions and Application Accelerator](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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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/). - -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 - -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. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. \ No newline at end of file From dd77a59c093730bb9433ec5b247b14a3f23907e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:32:09 -0300 Subject: [PATCH 30/76] refactor: update readme - Edge Function GitHub AutoDeploy --- .../edge-function-github-autodeploy/README.md | 73 +++---------------- 1 file changed, 11 insertions(+), 62 deletions(-) diff --git a/templates/javascript/edge-function-github-autodeploy/README.md b/templates/javascript/edge-function-github-autodeploy/README.md index 55e62774..2685b55c 100644 --- a/templates/javascript/edge-function-github-autodeploy/README.md +++ b/templates/javascript/edge-function-github-autodeploy/README.md @@ -1,77 +1,26 @@ # Edge Function Github AutoDeploy -Azion **Edge Function GitHub AutoDeploy** simplifies the deployment of edge functions integrated with Github Actions directly on the edge of the network. +Azion **Edge Function GitHub AutoDeploy** simplifies the deployment of edge functions integrated with Github Actions directly on the edge of the network. By using this template, you only need to code your edge function, and the deployment is done through GitHub Actions. It accelerates your workflow and guarantees a continuous deployment to keep your project up to date. -By using this template, you only need to code your edge function, and the deployment is done through GitHub Actions. It accelerates your workflow and guarantees a continuous deployment to keep your project up to date. - -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 functions with Edge Function GitHub AutoDeploy](https://www.azion.com/en/documentation/products/guides/edge-function-github-autodeploy/) guide. - ---- - -## Deploy Your Own - -Deploy this project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/github/edge-function-github-autodeploy "Deploy with Azion") +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 use the Edge Function GitHub AutoDeploy template](https://www.azion.com/en/documentation/products/guides/edge-function-github-autodeploy/) guide. --- -## 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. +## Requirements -For a more detailed step-by-step on using this template and requirements, check the [How to deploy edge functions with Edge Function GitHub AutoDeploy](https://www.azion.com/en/documentation/products/guides/edge-function-github-autodeploy/) guide. +Before using this template, you need to: -### Requirements +- 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. -- 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. +> **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. --- -## Continuous deployment - -Once the template is deployed, you can also 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 new **Edge Function GitHub AutoDeploy** repository on 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. +## Deploy your own -```bash - AZION_PERSONAL_TOKEN= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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/). - -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 this project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/github/edge-function-github-autodeploy "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/edge-function-github-autodeploy/). \ No newline at end of file From 77a024b7240cafb24c0f98d9253633b53fa8b9a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:35:39 -0300 Subject: [PATCH 31/76] refactor: update readme - Fauna DB --- .../javascript/faunadb-boilerplate/README.md | 93 ++----------------- 1 file changed, 10 insertions(+), 83 deletions(-) diff --git a/templates/javascript/faunadb-boilerplate/README.md b/templates/javascript/faunadb-boilerplate/README.md index e8eae9d9..2dfd4bc9 100644 --- a/templates/javascript/faunadb-boilerplate/README.md +++ b/templates/javascript/faunadb-boilerplate/README.md @@ -6,98 +6,25 @@ This repository is an example of the new GitHub repository created during the de --- -## Deploy Your Own +## Requirements -Deploy your own Fauna project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/fauna/faunadb-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 use the Fauna DB Boilerplate template through Azion](https://www.azion.com/en/documentation/products/guides/faunadb-boilerplate/) guide. - -### Requirements +Before using this template, you need to: - Create a [Fauna account](https://dashboard.fauna.com/register). - Create a database in the [Fauna Dashboard](https://docs.fauna.com/fauna/current/get_started/dashboard) and populate it with `demo data`, selecting this option while creating. - Create a new [collection](https://docs.fauna.com/fauna/current/cookbook/data_model/collections) named `Posts` within your database to use with this template. - Generate a [Fauna secret key](https://docs.fauna.com/fauna/v4/security/keys?lang=shell) for your database. -- 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 Application Accelerator](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 in the edge function, 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 finished, you'll be able to manage your project with a continuous deployment workflow and edit the args as desired. - -To do so, open your **Fauna DB Boilerplate EdgeDeploy** repository on GitHub. Then, go to **Settings** > **Secrets and variables** > **Action to add your variables**, following these instructions: +- 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. -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. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -```bash - AZION_PERSONAL_TOKEN= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: edge-... - id: azion_edge - ... - with: - .... - azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }} - .... - -``` - -3. Add the Redis Database access credentials to the *secrets*, being: - -- **FAUNA_SECRET**: the key to access your Fauna DB database using REST. - - In the Databases list on the Home page, select your database. This takes you to the Explorer page with your database highlighted. - - Hover over the database name to reveal the Keys icon. Click the key icon. - - In the Keys dialog, click CREATE KEY. - - The Database name is already populated. Choose Admin or Server Role and enter an optional Key Name. - - Click the SAVE button. - - Copy the KEY’S SECRET and paste on `FAUNA_SECRET` - - -```bash - FAUNA_SECRET= -``` - -4. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: Create args file - run: | - ... - "FAUNA_SECRET": "${{ secrets.FAUNA_SECRET }}", - ... -``` - -5. 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. - ---- - -## 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 Fauna project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/fauna/faunadb-boilerplate "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/faunadb-boilerplate/). \ No newline at end of file From 91c049b64fbc9422a7045fc27fe7eaff1564e5bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:38:48 -0300 Subject: [PATCH 32/76] refactor: update readme - Hello World --- templates/javascript/hello-world/README.md | 69 ++++------------------ 1 file changed, 10 insertions(+), 59 deletions(-) diff --git a/templates/javascript/hello-world/README.md b/templates/javascript/hello-world/README.md index e6148d55..d898dc54 100644 --- a/templates/javascript/hello-world/README.md +++ b/templates/javascript/hello-world/README.md @@ -2,74 +2,25 @@ **Hello World** is a popular resource used to demonstrate the basic syntax and structure of a programming language or development environment. The Azion Hello World template deploys an edge application that prints the text "Hello, World!" in your browser and you can use it as a starting point to become familiar with Azion Edge Platform and edge computing capabilities. -This repository is an example of the new GitHub repository created during the deployment. For a detailed step-by-step to deploy this template via Azion Real-Time Manager (RTM), check the [How to deploy the Hello World template](https://www.azion.com/en/documentation/products/guides/hello-world-template/) guide. +This repository is an example of the new GitHub repository created during the deployment. For a detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy the Hello World template](https://www.azion.com/en/documentation/products/guides/hello-world-template/) guide. --- -## Deploy Your Own +## Requirements -Deploy your own Hello World project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion/edge-hello-world "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 the Hello World template](https://www.azion.com/en/documentation/products/guides/hello-world-template/) 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. - -```bash - AZION_PERSONAL_TOKEN= -``` - -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 Hello World 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/azion/edge-hello-world "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/hello-world-template/). \ No newline at end of file From 12b0cc79a3c89e9d1fe1b7c70fa8964dcd80aa7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:44:10 -0300 Subject: [PATCH 33/76] refactor: update readme - HTMX --- templates/javascript/htmx-minimal/README.md | 78 ++++----------------- 1 file changed, 14 insertions(+), 64 deletions(-) diff --git a/templates/javascript/htmx-minimal/README.md b/templates/javascript/htmx-minimal/README.md index 2ce7a8b8..49461868 100644 --- a/templates/javascript/htmx-minimal/README.md +++ b/templates/javascript/htmx-minimal/README.md @@ -1,76 +1,26 @@ -# HTMX Minimal Example +# HTMX Boilerplate -Minimal example of using HTMX in an Azion edge function. +The **HTMX Boilerplate** template facilitates you to deploy and test a minimal example of the HTMX library in Azion Edge Platform. -## Deploy Your Own +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 and test HTMX on the edge with a template](https://www.azion.com/en/documentation/products/guides/htmx-boilerplate/) guide. -Deploy your own HTMX project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/htmx/htmx-boilerplate "Deploy with Azion") - - -## Settings - -To successfully deploy this template, you must provide the information to configure your Azion application. Fields identified with an asterisk are mandatory. - - * **Application Name***: the name of your edge application on Azion. - * **GitHub Personal Token***: your GitHub personal token. - * While generating your GitHub personal token, grant that your scope has the permissions to authorize an OAuth app or a personal token to access to public and private repositories, including read and write access to code. You must also enable the workflow option to allow adding and updating GitHub Actions workflow files. - -Note that permissions can be scoped either to a user or an organization or to a repository. Read the [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) documentation for more information. - -After filling out the form, click the **Next** button to start the deployment process. - -Once the template is deployed, you can edit and update your args and code. However, you'll need to declare secrets on your project's GitHub repository first to complete the second build with these changes. When the second build is completed, you can manage your project with a [continuous deployment workflow](#continuous-deployment). - -For a more detailed step-by-step on declaring your secrets and using this template, check the [How to deploy edge applications with the Next.js Static Boilerplate](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) guide for more details. - -## Important +--- -To guarantee the optimal performance of this template, it's necessary to activate the following Azion product: +## Requirements -* [Edge Functions](https://www.azion.com/en/documentation/products/edge-application/edge-functions/#edge-functions-management) +Before using this template, you need to: -You need to activate the product separately via RTM. Review the [Azion documentation](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) to do so. +- 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. -If this product is activated, the execution of this template could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. +> **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. -## Continuous deployment +--- -Once the template is deployed, you can edit it and update it, 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. +## Deploy your own -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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - -## 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 Real-Time Manager (RTM)](https://manager.azion.com/). - -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 HTMX project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/htmx/htmx-boilerplate "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/edge-application/domains/) documentation to read more about it. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/htmx-boilerplate/). \ No newline at end of file From e14fe52aeba247c33684b34446e3f69779bcc254 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:59:08 -0300 Subject: [PATCH 34/76] refactor: update readme - QStash EdgeFunction Scheduler --- .../javascript/qstash-scheduler/README.md | 189 ++---------------- 1 file changed, 12 insertions(+), 177 deletions(-) diff --git a/templates/javascript/qstash-scheduler/README.md b/templates/javascript/qstash-scheduler/README.md index 277a8b21..404f9339 100644 --- a/templates/javascript/qstash-scheduler/README.md +++ b/templates/javascript/qstash-scheduler/README.md @@ -1,193 +1,28 @@ # QStash EdgeFunction Scheduler -The **QStash EdgeFunction Scheduler** template is designed to set up and manage a custom edge function, which receives a user-configured schedule and dispatches it through [QStash](https://upstash.com/docs/qstash/overall/getstarted, a message queue and task scheduler for serverless runtimes. +The **QStash EdgeFunction Scheduler** template is designed to set up and manage a custom edge function, which receives a user-configured schedule and dispatches it through [QStash](https://upstash.com/docs/qstash/overall/getstarted), a message queue and task scheduler for serverless runtimes. -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 use the QStash EdgeFunction Scheduler template through Azion](https://www.azion.com/en/documentation/products/guides/qstash-edge-function-scheduler/) 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 and scheduling tasks, check the [How to use the QStash EdgeFunction Scheduler template through Azion](https://www.azion.com/en/documentation/products/guides/qstash-edge-function-scheduler/) guide. --- -## Deploy Your Own - -Deploy your own QStash project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/qstash-edgefunction-scheduler "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 use the QStash EdgeFunction Scheduler template through Azion](https://www.azion.com/en/documentation/products/guides/qstash-edge-function-scheduler/) guide. - -### Requirements +## Requirements Before using this template, you need to: -1. Create an [Upstash account](https://console.upstash.com/login). -2. In the [Upstash Console](https://console.upstash.com/qstash), get your **Current Signing Key**, **Next Signing Key**, and **QStash Token** within the **QStash** tab. -3. 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). -4. Enable [Edge Functions](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. - ---- - -## Scheduling tasks - -After the deployment is finished and propagated, you're able to start scheduling tasks. The tasks must be scheduled in any format that can be transmitted in the HTTP request. For example: json, xml, binary. The examples below are using JSON. - -To do so, you have two options: - -### Via terminal - -1. Get your application domain. -2. In the Upstash Console, copy the `QSTASH_TOKEN` within the QStash tab. -3. In your development environment, open the terminal. -4. Make an HTTP POST request to the specified URL to schedule your messages. - -Use the following exemples for your request, according to the interval required: - -### Via terminal - -1. Get your application domain. -2. In the [Upstash Console](https://console.upstash.com/qstash), copy the `QSTASH_TOKEN` from the **QStash** tab. -3. In your development environment, open the terminal. -4. Make an HTTP POST request to the specified URL to schedule your messages. - -Use the following exemples for your request, according to the interval required: - -#### Once - -```bash -curl --request POST "https://qstash.upstash.io/v1/publish/{add your domain here}" \ - -H "Authorization: Bearer {add your QStash token here}" \ - -H "Content-Type: application/json" \ - -d "{ \"hello\": \"world\"}" -``` - -#### Every minute - -```bash -curl --request POST "https://qstash.upstash.io/v1/publish/{add your domain here}" \ - -H "Authorization: Bearer {add your QStash token here}" \ - -H "Content-Type: application/json" \ - -H "Upstash-Cron: * * * * *" \ - -d "{ \"hello\": \"world\"}" -``` - -#### Every 10 minutes - -```bash -curl --request POST "https://qstash.upstash.io/v1/publish/{add your domain here}" \ - -H "Authorization: Bearer {add your QStash token here}" \ - -H "Content-Type: application/json" \ - -H "Upstash-Cron: */10 * * * *" \ - -d "{ \"hello\": \"world\"}" -``` +- Create an [Upstash account](https://console.upstash.com/login). +- In the [Upstash Console](https://console.upstash.com/qstash), get your **Current Signing Key**, **Next Signing Key**, and **QStash Token** within the **QStash** tab. +- 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. -#### Every hour - -```bash -curl --request POST "https://qstash.upstash.io/v1/publish/{add your domain here}" \ - -H "Authorization: Bearer {add your QStash token here}" \ - -H "Content-Type: application/json" \ - -H "Upstash-Cron: 0 * * * *" \ - -d "{ \"hello\": \"world\"}" -``` - -Where: - -| Flag | Description | -|---|---| -| `--request POST` | Specifies the method of request sent. In this case, a HTTP POST method to post or schedule a HTTP message. | -| `-H "Authorization"` | Provides authorization information through a token for authentication. You must add your QStash token here. | -| `-H "Content-Type"` | Specifies the content type of the request body. In this case, JSON format. | -| `-H "Upstash-Cron"` | Schedules a cron-like job in Upstash, allowing you to automate tasks at specific intervals. | -| `-d` | Provides the data for the request body, including the JSON payload. The backslashes (`\`) before the double quotes (`"`) are used to ensure that the quotes are treated as part of the data within the JSON payload. | - -Done. Your task is scheduled and will be executed according to the defined scheduling. - -Your scheduled tasks are visible in the [Upstash Console](https://console.upstash.com/qstash), within the **QStash** tab, for your review and monitoring. - -### Via Upstash console - -1. Copy your Azion application domain. -2. Go to the [Upstash Console](https://console.upstash.com/qstash) and open the **QStash** tab. -3. Complete the form with the requested information. -- In the type field, select **Scheduled** and choose the delay. -- Alternatively, select **Once** to send an immediate and unique message. -6. Click the **Schedule** button. - -Done. Your task is scheduled and visible in the **Scheduled Jobs** section for your review and monitoring. - -You can also publish them using a REST API request. For more information, read the [QStash documentation](https://upstash.com/docs/qstash/api/messages/create). +> **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. --- -### 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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml title=".github/workflows/main.yml" - - name: edge-... - id: azion_edge - ... - with: - .... - azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }} - .... +## Deploy your own -``` - -3. Add the Upstash Signing Keys to the *secrets*, being: - -- **QSTASH_CURRENT_SIGNING_KEY**: a string to sign all messages sent to the destination. -- Go to your Upstash Console and copy the `QSTASH_CURRENT_SIGNING_KEY` in the **QStash** tab. -- **QSTASH_NEXT_SIGNING_KEY**: a string used to sign messages after you've rotated your signing keys. - - Go to your Upstash Console and copy the `QSTASH_NEXT_SIGNING_KEY` from the **QStash** tab. - -```bash -QSTASH_CURRENT_SIGNING_KEY= -QSTASH_NEXT_SIGNING_KEY= -``` - -4. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml title=".github/workflows/main.yml" - - name: Create args file - run: | - ... - "QSTASH_CURRENT_SIGNING_KEY": "${{ secrets.QSTASH_CURRENT_SIGNING_KEY }}", - "QSTASH_NEXT_SIGNING_KEY": "${{ secrets.QSTASH_NEXT_SIGNING_KEY }}" - ... -``` - -5. 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. - ---- - -## 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 Real-Time Manager (RTM). Once the template is deployed, you also have full control over customizing your Upstash account and QStash configurations. - -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. 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 QStash project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/qstash-edgefunction-scheduler "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 on deploying this template and scheduling tasks, check the [documentation](https://www.azion.com/en/documentation/products/guides/qstash-edge-function-scheduler/). \ No newline at end of file From 99535cda2c7f998e71c6a020521747535a75849e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 17:03:11 -0300 Subject: [PATCH 35/76] refactor: update readme - Turso Starter Kit --- .../javascript/turso-starter-kit/README.md | 67 +++---------------- 1 file changed, 8 insertions(+), 59 deletions(-) diff --git a/templates/javascript/turso-starter-kit/README.md b/templates/javascript/turso-starter-kit/README.md index 2c570c56..364120f1 100644 --- a/templates/javascript/turso-starter-kit/README.md +++ b/templates/javascript/turso-starter-kit/README.md @@ -8,73 +8,22 @@ This template uses LibSQL `0.5.3`. --- -## Deploy Your Own - -Deploy your own Turso project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/turso/turso-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 integrate a Turso database with Azion using a template](https://www.azion.com/en/documentation/products/guides/turso-starter-kit/) guide. - -### Requirements +## Requirements - Create a [Turso account](https://accounts.turso.tech/sign-up). - Install the [Turso CLI](https://docs.turso.tech/cli/introduction). - Create a [database](https://docs.turso.tech/quickstart) with a table called `posts`, and the fields `id` and `message`. -- 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 Application Accelerator](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. +- 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. ---- - -## 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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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 [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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 +## Deploy your own -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/). - -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 Turso project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/turso/turso-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/turso-starter-kit/). \ No newline at end of file From bd650e48a67dc242e80f3658fee8dc82ec624243 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 17:06:52 -0300 Subject: [PATCH 36/76] refactor: update readme - Upstash GeoLocation --- .../javascript/upstash-geolocation/README.md | 123 ++---------------- 1 file changed, 12 insertions(+), 111 deletions(-) diff --git a/templates/javascript/upstash-geolocation/README.md b/templates/javascript/upstash-geolocation/README.md index caa21926..777d59ea 100644 --- a/templates/javascript/upstash-geolocation/README.md +++ b/templates/javascript/upstash-geolocation/README.md @@ -4,127 +4,28 @@ The **Upstash GeoLocation** template is an automation designed to deploy a datab These messages are delivered through a static interface, based on HTML and generated by the template after deployment. -This repository is an example of the new GitHub repository created during the deployment. The template also incorporates a file with location-based greetings, which are retrieved from the integration with Upstash. - -For a more detailed step-by-step to deploy this template via Azion Real-Time Manager (RTM), check the [How to use the Upstash GeoLocation EdgeDeploy template through Azion](https://www.azion.com/en/documentation/products/guides/upstash-geolocation-edgedeploy/) guide. - ---- - -## Deploy Your Own - -Deploy your own Upstash project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/upstash-geolocation "Deploy with Azion") +This repository is an example of the new GitHub repository created during the deployment. The template also incorporates a file with location-based greetings, which are retrieved from the integration with Upstash. For a more detailed step-by-step to deploy this template via Azion Real-Time Manager (RTM), check the [How to use Upstash GeoLocation through Azion](https://www.azion.com/en/documentation/products/guides/upstash-geolocation-edgedeploy/) guide. --- -## 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 use the Upstash GeoLocation EdgeDeploy template through Azion](https://www.azion.com/en/documentation/products/guides/upstash-geolocation-edgedeploy/) guide. - -### Requirements +## Requirements Before using this template, you need to: -1. Create an [Azion account](https://manager.azion.com/signup). -2. Create an [Upstash account](https://console.upstash.com/login). -3. Create a Global Database for the best available edge latency in the [Upstash Console](https://console.upstash.com/). -4. 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). -5. Enable [Edge Functions and Application Accelerator](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. - -### Key configurations - -Upstash GeoLocation creates a new Azion edge application and its domain. It also creates an edge function to provide the arguments for the geolocation, a new repository in your GitHub account based on a [public template](https://github.com/aziontech/azion-samples/tree/dev/templates/upstash-geolocation), and a static interface to exhibit the messages. +- Create an [Azion account](https://manager.azion.com/signup). +- Create an [Upstash account](https://console.upstash.com/login). +- Create a Global Database for the best available edge latency in the [Upstash Console](https://console.upstash.com/). +- 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. -In this function, the `upstash/redis` library is integrated, connecting to your Upstash Global Database and retrieving the message based on the user's location. This location is taken from the metadata `["geoip_country_code"]`. - -The template also incorporates location-based greetings in your database, which are retrieved from the integration with Upstash, similar to this: - -```bash -Welcome to Upstash CLI - -set BR "Olá, tudo bem!" -OK -set GB "Ey up?" -OK -set US "Yo, what’s up?" -OK -set IN "Namaste" -OK -``` -You can customize these greetings on your Upstash database to attend to your necessities. - -To know more about how to edit and customize your project's settings, go to the [Management](#management) section. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. --- -## Continuous deployment - -Once the template is deployed, you can edit and update your args and code in the edge function, 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 finished, you'll be able to manage your project with a continuous deployment workflow and edit the args as desired. +## Deploy your own -To do so, open your **Upstash GeoLocation EdgeDeploy** repository on GitHub. Then, go to **Settings** > **Secrets and variables** > **Action to add your variables**, 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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: edge-... - id: azion_edge - ... - with: - .... - azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }} - .... - -``` - -3. Add the Redis Database access credentials to the *secrets*, being: - -- **UPSTASH_REDIS_REST_URL**: the URL to access your Upstash database using REST. - - Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_URL` in your database page. -- **UPSTASH_REDIS_REST_TOKEN**: the token to authorize access to your Upstash database using REST. - - Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_TOKEN` in your database page. - -```bash - UPSTASH_REDIS_REST_URL= - UPSTASH_REDIS_REST_TOKEN=; -``` - -4. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: Create args file - run: | - ... - "UPSTASH_REDIS_REST_URL": "${{ secrets.UPSTASH_REDIS_REST_URL }}", - "UPSTASH_REDIS_REST_TOKEN": "${{ secrets.UPSTASH_REDIS_REST_TOKEN }}", - ... -``` - -5. 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. - ---- - -## 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 Real-Time Manager (RTM). Once the template is deployed, you also have full control over customizing your Upstash account and database. - -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. For specific Upstash-related questions, check the [Upstash documentation](https://docs.upstash.com/). +Deploy your own Upstash project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/upstash-geolocation "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/upstash-geolocation-edgedeploy/). \ No newline at end of file From 489ec5a21e03166200f8d4aa0da433af7a259aac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Fri, 25 Oct 2024 17:11:43 -0300 Subject: [PATCH 37/76] refactor: update readme - Upstash Rate Limit --- .../javascript/upstash-ratelimit/README.md | 105 +++--------------- 1 file changed, 13 insertions(+), 92 deletions(-) diff --git a/templates/javascript/upstash-ratelimit/README.md b/templates/javascript/upstash-ratelimit/README.md index b3972390..6d67e37f 100644 --- a/templates/javascript/upstash-ratelimit/README.md +++ b/templates/javascript/upstash-ratelimit/README.md @@ -1,109 +1,30 @@ -## Upstash Rate Limiting template +## Upstash Rate Limit -The **Upstash Rate Limiting** template helps you to implement rate limiting in a serverless environment, without requiring extensive manual setup. This template includes configurations for limiting requests and window limit. +The **Upstash Rate Limit** template helps you to implement rate limiting in a serverless environment, without requiring extensive manual setup. This template includes configurations for limiting requests and window limit. It works in conjunction with Azion **Edge Functions**, being possible to adjust the initial setup based on the args. Additionally, this template creates a new GitHub repository that allows a continuous deployment workflow. This way, you're able to further configure and customize further the setup to attend to your needs, obtaining easy management and delivery of your personalized content. -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 the Upstash Rate Limiting template through Azion](https://www.azion.com/en/documentation/products/guides/upstash-rate-limiting/) 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, check the [How to deploy the Upstash Rate Limit template through Azion](https://www.azion.com/en/documentation/products/guides/upstash-rate-limiting/) guide. --- -## Deploy Your Own - -Deploy your own Upstash project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/upstash-ratelimit "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 the Upstash Rate Limiting template through Azion](https://www.azion.com/en/documentation/products/guides/upstash-rate-limiting/) guide. - -### Requirements +## Requirements To start using this template, you need to: -1. Create an [Upstash account](https://console.upstash.com/login). -2. Create a Global Database for the best available edge latency in the [Upstash Console](https://console.upstash.com/). -3. 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)). -4. Enable [Edge Functions](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. - ---- - -### Continuous deployment - -The template args can also be updated and it's possible to implement a continuous deployment workflow. However, you'll need first to declare secrets on your project's GitHub repository to successfully complete the second build with the changes. Once this second build is completed, you'll be able to manage your project with a continuous deployment workflow and edit the args as desired. +- Create an [Upstash account](https://console.upstash.com/login). +- Create a Global Database for the best available edge latency in the [Upstash Console](https://console.upstash.com/). +- 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. -To do so, open your **Upstash Rate Limit** repository on 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= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: edge-... - id: azion_edge - ... - with: - .... - azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }} - .... - -``` - -3. Add the Redis Database access credentials to the *secrets*, being: - -- **UPSTASH_REDIS_REST_URL**: the URL to access your Upstash database using REST. - - Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_URL` in your database page. -- **UPSTASH_REDIS_REST_TOKEN**: the token to authorize access to your Upstash database using REST. - - Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_TOKEN` in your database page. -- **UPSTASH_LIMIT**: the maximum number of requests. Example: `6`. -- **UPSTASH_LIMIT_WINDOW**: the time window for new requests. Example: `10 s`. (can be used: "ms" | "s" | "m" | "h" | "d"). - -```bash - UPSTASH_REDIS_REST_URL= - UPSTASH_REDIS_REST_TOKEN= - UPSTASH_LIMIT=6 - UPSTASH_LIMIT_WINDOW=10 s // "ms" | "s" | "m" | "h" | "d"; -``` - -4. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```yml - - name: Create args file - run: | - ... - "UPSTASH_REDIS_REST_URL": "${{ secrets.UPSTASH_REDIS_REST_URL }}", - "UPSTASH_REDIS_REST_TOKEN": "${{ secrets.UPSTASH_REDIS_REST_TOKEN }}", - "UPSTASH_LIMIT": "${{ secrets.UPSTASH_LIMIT }}", - "UPSTASH_LIMIT_WINDOW": "${{ secrets.UPSTASH_LIMIT_WINDOW }}" - ... -``` - -5. Open a pull request with 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 +## Deploy your own -Considering the initial setup may not be optimal for your specific web application, all settings can be customized any time you need using Azion Real-Time Manager (RTM). Once the template is deployed, you also have full control over customizing your Upstash account and database. - -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 Upstash project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/upstash-ratelimit "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/edge-application/domains/) documentation to read more about it. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/upstash-rate-limiting/). \ No newline at end of file From 8720a1028e2a7a9789bc73cfdc5b423002d42670 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:04:33 -0300 Subject: [PATCH 38/76] refactor: update readme - Ecommerce Stationery NextJs --- .../ecommerce-stationery-nextjs/README.md | 50 +++++++------------ 1 file changed, 17 insertions(+), 33 deletions(-) diff --git a/templates/nextjs/ecommerce-stationery-nextjs/README.md b/templates/nextjs/ecommerce-stationery-nextjs/README.md index 2cd6905b..29d74861 100644 --- a/templates/nextjs/ecommerce-stationery-nextjs/README.md +++ b/templates/nextjs/ecommerce-stationery-nextjs/README.md @@ -1,48 +1,32 @@ -# [Preview](https://ecommerce-stationery-next-js.vercel.app/) +# Ecommerce Stationery NextJs +The **Ecommerce Stationery NextJs** template enables you to deploy a Next.js-based e-commerce site in a few steps, directly to the edge. It includes components and tools to add functionality, streamlining the customization process. -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +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/use-a-template-via-azion-console/). ---- - -## Deploy Your Own - -Deploy your own Ecommerce Stationery NextJs project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/ecommerce-stationery-next "Deploy with Azion") +This template uses Next.js version `13.4.6` and React version `18.2.0`. +> **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. --- -## Getting Started - -First, run the development server: +## Requirements -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -``` +Before using this template, you need to: -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +- 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. -You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file. +> **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. -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +--- -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +## Deploy your own -## Deploy on Vercel +Deploy your own Ecommerce Stationery NextJs project with Azion. -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/ecommerce-stationery-next "Deploy with Azion") -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 3a553bfbe16d70264eb61cc3545e5758b2fb3717 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:08:10 -0300 Subject: [PATCH 39/76] refactor: update readme - Kupingplug --- templates/nextjs/kupingplug/README.md | 49 ++++++++++----------------- 1 file changed, 17 insertions(+), 32 deletions(-) diff --git a/templates/nextjs/kupingplug/README.md b/templates/nextjs/kupingplug/README.md index 1e84393a..b2d0925c 100644 --- a/templates/nextjs/kupingplug/README.md +++ b/templates/nextjs/kupingplug/README.md @@ -1,47 +1,32 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Kupingplug ---- - -## Deploy Your Own +The **Kupingplug** template provides an option to easily create and deploy an e-commerce website using TailwindCSS and Next.js. -Deploy your own Kupingplug project with Azion. +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/use-a-template-via-azion-console/). -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/kupingplug "Deploy with Azion") +This template uses Next.js version `14.0.3`, React version `18`, and TailwindCSS version `3.3.0`. +> **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. --- -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +## Requirements -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Before using this template, you need to: -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +- 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. -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +> **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. -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +--- -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +## Deploy your own -## Deploy on Vercel +Deploy your own Kupingplug project with Azion. -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/kupingplug "Deploy with Azion") -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). From 8aa8927894b9c3ad62df55c61ae6f5ab1bd72ab9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:12:29 -0300 Subject: [PATCH 40/76] refactor: update readme - Next.js App + Configurations --- .../nextjs/nextjs-app-13-5-6-config/README.md | 67 +++---------------- 1 file changed, 9 insertions(+), 58 deletions(-) diff --git a/templates/nextjs/nextjs-app-13-5-6-config/README.md b/templates/nextjs/nextjs-app-13-5-6-config/README.md index f7401842..357afc07 100644 --- a/templates/nextjs/nextjs-app-13-5-6-config/README.md +++ b/templates/nextjs/nextjs-app-13-5-6-config/README.md @@ -12,70 +12,21 @@ This template uses Next version `13.5.6`. --- -## Deploy Your Own +## Requirements -Deploy your own Next.js project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/nextjs-app-configurations "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 the Next.js App + Configurations template](https://www.azion.com/en/documentation/products/guides/nextjs-app-configurations/) 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 Funtions and Application Accelerator](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= -``` - -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 [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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 Next.js 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/nextjs/nextjs-app-configurations "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/nextjs-app-configurations/). \ No newline at end of file From f63fb0f2f9aac0be56c516b7e1e61a6e11283c03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:18:06 -0300 Subject: [PATCH 41/76] refactor: update readme - Next.js App + Middleware --- .../nextjs-app-13-5-6-middleware/README.md | 68 +++---------------- 1 file changed, 9 insertions(+), 59 deletions(-) diff --git a/templates/nextjs/nextjs-app-13-5-6-middleware/README.md b/templates/nextjs/nextjs-app-13-5-6-middleware/README.md index c13c2aa3..922ae89d 100644 --- a/templates/nextjs/nextjs-app-13-5-6-middleware/README.md +++ b/templates/nextjs/nextjs-app-13-5-6-middleware/README.md @@ -20,71 +20,21 @@ Next.js App + Middleware uses Next version `13.5.6`. --- -## Deploy Your Own +## Requirements -Deploy your own Next.js project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/nextjs-app-middleware "Deploy with Azion") - ---- - -## Usage information - -To use this template, you must [sign in on Azion Console](https://console.azion.com/login). +Before using this template, you need to: -> If you haven't created an account, go to the [signup page](https://console.azion.com/signup) to complete the registration. +- 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. -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 the Next.js App + Middleware template](https://www.azion.com/en/documentation/products/guides/nextjs-app-middleware/) 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 Application Accelerator](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. --- -## 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= -``` +## Deploy your own -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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/). - -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 - -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 your own Next.js project with Azion. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/nextjs-app-middleware "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/nextjs-app-middleware/). \ No newline at end of file From 346ae77bc0ce3e864bf63114d207e1a416858c02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:29:49 -0300 Subject: [PATCH 42/76] refactor: update readme - Next.js Pages + Configurations --- .../nextjs-app-13-5-6-middleware/README.md | 16 +--- .../nextjs-pages-13-5-6-config/README.md | 79 +++---------------- 2 files changed, 14 insertions(+), 81 deletions(-) diff --git a/templates/nextjs/nextjs-app-13-5-6-middleware/README.md b/templates/nextjs/nextjs-app-13-5-6-middleware/README.md index 922ae89d..3ad320b5 100644 --- a/templates/nextjs/nextjs-app-13-5-6-middleware/README.md +++ b/templates/nextjs/nextjs-app-13-5-6-middleware/README.md @@ -1,18 +1,8 @@ # Next.js App + Middleware -The **Next.js App + Middleware** accelerates the deployment of a Next.js application with custom configurations, App Router, and a middleware to run it directly on the edge. - -This example contains: - -* Edge API Route; -* Common page without middleware action -* Middleware - rewrite; -* Middleware - redirect; -* Middleware - go to response; -* Middleware - returns a new response; -* Middleware - add header; -* Middleware - add cookie; -* Middleware - throw error; +The **Next.js App + Middleware** accelerates the deployment of a Next.js application with custom configurations, App Router, and a middleware to run it directly on the edge. This template deploys a basic Next.js application containing a domain to access the Single-Page Application (SPA), an [Edge Storage configuration](https://www.azion.com/en/documentation/products/store/edge-storage/), cache settings, Gzip compression, and Rules Engine rules to improve the performance and delivery of static files. Additionally, it creates a new GitHub repository, including a GitHub Action to enable a continuous development workflow and keep your application up to date. + +**Next.js App + Middleware** creates files to implement the [App Router format](https://nextjs.org/docs/app), with the index page, edge API routing, and Custom Route Handler created in the new repository during the deployment. It also includes a [middleware](https://nextjs.org/docs/app/building-your-application/routing/middleware) that allows you to modify the response for a request and control different aspects of the application, such as performing redirects, setting headers, and others. 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 the Next.js App + Middleware template](https://www.azion.com/en/documentation/products/guides/nextjs-app-middleware/) guide. diff --git a/templates/nextjs/nextjs-pages-13-5-6-config/README.md b/templates/nextjs/nextjs-pages-13-5-6-config/README.md index ae8e1ffe..5dcf12d0 100644 --- a/templates/nextjs/nextjs-pages-13-5-6-config/README.md +++ b/templates/nextjs/nextjs-pages-13-5-6-config/README.md @@ -1,16 +1,8 @@ # Next.js Pages + Configurations -The **Next.js Pages + Middleware** template enables you to quickly deploy a Next.js application with Pages Router, a middleware, and custom configurations. +The **Next.js Pages + Configurations** template enables you to quickly deploy a Next.js application with Pages Router and custom configurations This template deploys a basic Next.js application containing a domain to access the Single-Page Application (SPA), an [Edge Storage configuration](https://www.azion.com/en/documentation/products/store/edge-storage/), cache settings, Gzip compression, and Rules Engine rules to improve the performance and delivery of static files. Additionally, it creates a new GitHub repository, including a GitHub Action to enable a continuous development workflow and keep your application up to date. -This example contains: - -* Edge API Route; -* Config to rewrite before files; -* Config to rewrite after files; -* Config to fallback; -* Config to simple redirect; -* Config to redirect permanent; -* Config to add headers; +**Next.js Pages + Configurations** also creates files to implement the [Pages Router format](https://nextjs.org/docs/pages), to use a file-system router to map each file to a route. 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 the Next.js Pages + Configurations template](https://www.azion.com/en/documentation/products/guides/nextjs-pages-configurations/) guide. @@ -18,70 +10,21 @@ This template uses Next version `13.5.6`. --- -## Deploy Your Own - -Deploy your own Next.js project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/nextjs-pages-configurations "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. +## Requirements -For a more detailed step-by-step on using this template and requirements, check the [How to deploy the Next.js Pages + Configurations template](https://www.azion.com/en/documentation/products/guides/nextjs-pages-configurations/) guide. +Before using this template, you need to: -### Requirements +- 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. -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 [product 1 and product 2](https://www.azion.com/en/documentation/products/guides/billing-and-subscriptions/) in your Azion account. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. --- -## 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. +## Deploy your own -```bash - AZION_PERSONAL_TOKEN= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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/). - -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 Next.js 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/nextjs/nextjs-pages-configurations "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/nextjs-pages-configurations/). \ No newline at end of file From e51f2455fc129a0d7417ba4fb640d60c4b2c37a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:33:59 -0300 Subject: [PATCH 43/76] refactor: update readme - Next.js Pages + Middleware --- .../nextjs-pages-13-5-6-middleware/README.md | 81 +++---------------- 1 file changed, 12 insertions(+), 69 deletions(-) diff --git a/templates/nextjs/nextjs-pages-13-5-6-middleware/README.md b/templates/nextjs/nextjs-pages-13-5-6-middleware/README.md index c3f9a602..03024151 100644 --- a/templates/nextjs/nextjs-pages-13-5-6-middleware/README.md +++ b/templates/nextjs/nextjs-pages-13-5-6-middleware/README.md @@ -1,17 +1,8 @@ # Next.js Pages + Middleware -The **Next.js Pages + Middleware** template enables you to quickly deploy a Next.js application with Pages Router, a middleware, and custom configurations. - -This example contains: -* Edge API Route; -* Common page without middleware action -* Middleware - rewrite; -* Middleware - redirect; -* Middleware - go to response; -* Middleware - returns a new response; -* Middleware - add header; -* Middleware - add cookie; -* Middleware - throw error; +The **Next.js Pages + Middleware** template enables you to quickly deploy a Next.js application with Pages Router, a middleware, and custom configurations. This template deploys a basic Next.js application containing a domain to access the Single-Page Application (SPA), an [Edge Storage configuration](https://www.azion.com/en/documentation/products/store/edge-storage/), cache settings, Gzip compression, and Rules Engine rules to improve the performance and delivery of static files. Additionally, it creates a new GitHub repository, including a GitHub Action to enable a continuous development workflow and keep your application up to date. + +**Next.js Pages + Middleware** also creates files to implement the [Pages Router format](https://nextjs.org/docs/pages), to use a file-system router to map each file to a route. It also includes a [middleware](https://nextjs.org/docs/app/building-your-application/routing/middleware) that allows you to modify the response for a request and control different aspects of the application, such as performing redirects, setting headers, and others. 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 the Next.js Pages + Middleware template](https://www.azion.com/en/documentation/products/guides/nextjs-pages-middleware/) guide. @@ -19,69 +10,21 @@ This template uses Next version `13.5.6`. --- -## Deploy Your Own - -Deploy your own Next.js project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/nextjs-pages-middleware "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 the Next.js Pages + Middleware template](https://www.azion.com/en/documentation/products/guides/nextjs-pages-middleware/) 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 Application Accelerator](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= -``` +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 [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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 +## Deploy your own -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/). - -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 Next.js project with Azion. -### Custom domain +[![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/nextjs-pages-middleware "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/nextjs-pages-middleware/). \ No newline at end of file From b9e8c26d25f794fcb0fc8413456d9eb7eb97e3aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:36:17 -0300 Subject: [PATCH 44/76] refactor: update readme - next static 13 --- .../nextjs-static-boilerplate-13/README.md | 61 ------------------- 1 file changed, 61 deletions(-) diff --git a/templates/nextjs/nextjs-static-boilerplate-13/README.md b/templates/nextjs/nextjs-static-boilerplate-13/README.md index 5707c231..6d7dc511 100644 --- a/templates/nextjs/nextjs-static-boilerplate-13/README.md +++ b/templates/nextjs/nextjs-static-boilerplate-13/README.md @@ -36,64 +36,3 @@ Features that require a Node.js server, or dynamic logic that cannot be computed - Incremental Static Regeneration - Image Optimization (with the default loader) - Draft Mode - ---- - -## 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 Next.js Static Boilerplate](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) guide for more details. - -### 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. - -```bash - AZION_PERSONAL_TOKEN= -``` - -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: - -```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. - ---- - -## 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/). - -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 - -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. From 24fe243ae33d9fab35475a42226d09d51ef9b327 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:44:16 -0300 Subject: [PATCH 45/76] refactor: update readme - Next 14 Boilerplate --- .../nextjs-static-boilerplate-14/README.md | 76 ++++--------------- 1 file changed, 16 insertions(+), 60 deletions(-) diff --git a/templates/nextjs/nextjs-static-boilerplate-14/README.md b/templates/nextjs/nextjs-static-boilerplate-14/README.md index 3351bd27..9270421e 100644 --- a/templates/nextjs/nextjs-static-boilerplate-14/README.md +++ b/templates/nextjs/nextjs-static-boilerplate-14/README.md @@ -1,6 +1,6 @@ # Next.js Static Boilerplate -The **Next.js Static Boilerplate** is designed to simplify and enhance the deployment process for Next.js Static.js applications directly on the edge of the network. +The **Next.js Static Boilerplate** provides an automation solution to simplify and enhance the deployment of Next.js Static 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 Next.js Static Boilerplate](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) guide. @@ -8,12 +8,25 @@ This template uses Next.js version `14.1.4`. --- -## Deploy Your Own +## Requirements + +Before using this template, you need to: + +- 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 [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. + +--- + +## Deploy your own Deploy your own Next.js project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/nextjs/next-static-boilerplate "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/). + --- ## Static Exports @@ -41,61 +54,4 @@ Features that require a Node.js server, or dynamic logic that cannot be computed - Middleware - Incremental Static Regeneration - Image Optimization (with the default loader) -- Draft Mode - ---- - -## 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 must 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 Next.js Static Boilerplate](https://www.azion.com/en/documentation/products/guides/nextjs-static-boilerplate/) guide for more details. - -### 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. - -```bash - AZION_PERSONAL_TOKEN= -``` -2. Add the environments for use in the action workflow in the **main.yml** file, included in the **.github/workflows** folder of your repository: -```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. - ---- - -## 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/). - -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 - -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. +- Draft Mode \ No newline at end of file From 76f286acf2764e839fc49ca25e55e41fc0f89ede Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:53:20 -0300 Subject: [PATCH 46/76] refactor: update readme - NextJs Store Ecommerce --- .../nextjs-store-ecommerce-template/README.md | 47 +++++++------------ 1 file changed, 16 insertions(+), 31 deletions(-) diff --git a/templates/nextjs/nextjs-store-ecommerce-template/README.md b/templates/nextjs/nextjs-store-ecommerce-template/README.md index 39a05047..350d647c 100644 --- a/templates/nextjs/nextjs-store-ecommerce-template/README.md +++ b/templates/nextjs/nextjs-store-ecommerce-template/README.md @@ -1,45 +1,30 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# NextJs Store Ecommerce ---- - -## Deploy Your Own +The **NextJs Store Ecommerce** template provides a starter solution for quickly deploying your Next.js-based e-commerce web project. 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/use-a-template-via-azion-console/). -Deploy your own NextJs Store Ecommerce project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/nextjs-store-ecommerce "Deploy with Azion") +This template uses Next.js version `12.2.1`, React version `18.2.0`, and TailwindCSS version `3.1.5`. +> **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. --- -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -``` +## Requirements -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Before using this template, you need to: -You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. +- 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. -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`. +> **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. -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +--- -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +## Deploy your own -## Deploy on Vercel +Deploy your own NextJs Store Ecommerce project with Azion. -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/nextjs-store-ecommerce "Deploy with Azion") -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 777a222cd3df46b300a5029631616c5353062288 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:57:27 -0300 Subject: [PATCH 47/76] refactor: update readme - Simple Ecommerce Nextjs --- .../nextjs/simple-ecommerce-nextjs/README.md | 27 ++++++++++++------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/templates/nextjs/simple-ecommerce-nextjs/README.md b/templates/nextjs/simple-ecommerce-nextjs/README.md index 21c7d83d..4d687078 100644 --- a/templates/nextjs/simple-ecommerce-nextjs/README.md +++ b/templates/nextjs/simple-ecommerce-nextjs/README.md @@ -1,23 +1,30 @@ -![github blog post 2](https://user-images.githubusercontent.com/64803272/222930765-dae53a8e-9811-4829-8410-43dfa148ddf1.png) +# Simple Ecommerce Nextjs -# Welcome +The **Simple Ecommerce Next.js** template provides a starter solution for quickly deploying your Next.js-based e-commerce web project. This project uses use-shopping-cart to handle the shopping cart and logic for Stripe. 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/use-a-template-via-azion-console/). -Welcome! This is a repository containing the starter code and final code from my tutorial [Building a shopping cart in Next.js with use-shopping-cart and Stripe](https://codingwithlucy.hashnode.dev/build-a-shopping-cart-in-nextjs-with-use-shopping-cart-and-stripe). +This template uses Next.js version `13.1.6`, React version `18.2.0`, and TailwindCSS version `3.2.6`. -Please refer to [my blog post](https://codingwithlucy.hashnode.dev/build-a-shopping-cart-in-nextjs-with-use-shopping-cart-and-stripe) for full instructions on how to use this code. +> **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 Simple Ecommerce Next.js project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/simple-ecommerce-next "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. --- -## Branches +## Deploy your own + +Deploy your own Simple Ecommerce Next.js project with Azion. + +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/simple-ecommerce-next "Deploy with Azion") -- `main`: starter code (use this if you would like to follow along with the tutorial) -- `final-version`: final code (what is currently deployed on Vercel) +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From de12978c866b36517b43ee62d01e34088d6679a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Mon, 28 Oct 2024 17:01:55 -0300 Subject: [PATCH 48/76] refactor: update readme - Space Jelly Shop --- templates/nextjs/space-jelly-shop/README.md | 51 +++++++-------------- 1 file changed, 16 insertions(+), 35 deletions(-) diff --git a/templates/nextjs/space-jelly-shop/README.md b/templates/nextjs/space-jelly-shop/README.md index 673d3db3..bbd98d6d 100644 --- a/templates/nextjs/space-jelly-shop/README.md +++ b/templates/nextjs/space-jelly-shop/README.md @@ -1,49 +1,30 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Space Jelly Shop ---- - -## Deploy Your Own +The **Space Jelly Shop** template helps you to quickly deploy a new stylish e-commerce built with Next.js, React, and TypeScript. This project uses use-shopping-cart to handle the shopping cart and logic for Stripe. 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/use-a-template-via-azion-console/). -Deploy your own Space Jelly Shop project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/space-jelly-shop "Deploy with Azion") +This template uses Next.js version `13.1.6`, React version `18.2.0`, and TypeScript version `4.9.5`. +> **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. --- -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -``` +## Requirements -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Before using this template, you need to: -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. +- 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. -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. +> **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. -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +--- -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +## Deploy your own -## Deploy on Vercel +Deploy your own Space Jelly Shop project with Azion. -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/space-jelly-shop "Deploy with Azion") -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From da8d42e9ab175a1940e18e422c04a649a948960a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:04:18 -0300 Subject: [PATCH 49/76] refactor: update readme - Astro Audiophile --- templates/astro/astro-audiophile/README.md | 63 ++++++++-------------- 1 file changed, 22 insertions(+), 41 deletions(-) diff --git a/templates/astro/astro-audiophile/README.md b/templates/astro/astro-audiophile/README.md index c204c7ca..9e1f5cbb 100644 --- a/templates/astro/astro-audiophile/README.md +++ b/templates/astro/astro-audiophile/README.md @@ -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/use-a-template-via-azion-console/). + +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/use-a-template-via-azion-console/). \ No newline at end of file From 8bcd3e7a5ba5a3aeeef48ca67b4d067a7c4d643a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:08:43 -0300 Subject: [PATCH 50/76] refactor: update readme - Astro Blog Starter Kit --- templates/astro/astro-blog/README.md | 64 ++++------------------------ 1 file changed, 9 insertions(+), 55 deletions(-) diff --git a/templates/astro/astro-blog/README.md b/templates/astro/astro-blog/README.md index a88fcec9..cadccce5 100644 --- a/templates/astro/astro-blog/README.md +++ b/templates/astro/astro-blog/README.md @@ -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= -``` +## 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/). \ No newline at end of file From 1d88210406a0464652f37a93a41f9667fa87ddb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:17:13 -0300 Subject: [PATCH 51/76] refactor: update readme - Astro Boilerplate --- templates/astro/astro-boilerplate/README.md | 71 +++------------------ 1 file changed, 10 insertions(+), 61 deletions(-) diff --git a/templates/astro/astro-boilerplate/README.md b/templates/astro/astro-boilerplate/README.md index b231ed4b..5862f912 100644 --- a/templates/astro/astro-boilerplate/README.md +++ b/templates/astro/astro-boilerplate/README.md @@ -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= -``` +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/). \ No newline at end of file From 87413b59b1271e0d380b295b4759f97d20f45a46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:23:40 -0300 Subject: [PATCH 52/76] refactor: update readme - Astro Ecommerce --- templates/astro/astro-audiophile/README.md | 4 +- templates/astro/astro-ecommerce/README.md | 105 ++++----------------- 2 files changed, 18 insertions(+), 91 deletions(-) diff --git a/templates/astro/astro-audiophile/README.md b/templates/astro/astro-audiophile/README.md index 9e1f5cbb..83b40d90 100644 --- a/templates/astro/astro-audiophile/README.md +++ b/templates/astro/astro-audiophile/README.md @@ -2,7 +2,7 @@ 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/use-a-template-via-azion-console/). +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`. @@ -29,4 +29,4 @@ 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/use-a-template-via-azion-console/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file diff --git a/templates/astro/astro-ecommerce/README.md b/templates/astro/astro-ecommerce/README.md index 140824fd..1d6024c6 100644 --- a/templates/astro/astro-ecommerce/README.md +++ b/templates/astro/astro-ecommerce/README.md @@ -1,105 +1,32 @@ -# Welcome to [Astro Ecommerce](https://www.creative-tim.com/astro) +# Astro Ecommerce -![version](https://img.shields.io/badge/version-1.1.0-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/astro-ecommerce.svg?maxAge=2592000)](https://github.com/creativetimofficial/astro-ecommerce/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/astro-ecommerce.svg?maxAge=2592000)](https://github.com/creativetimofficial/astro-ecommerce/issues?q=is%3Aissue+is%3Aclosed) +The **Astro Ecommerce** template provides a starter solution for quickly deploying your e-commerce web project. Built on Astro's next-gen island architecture, it features a simple design that includes components and functionalities to facilitate a smooth customization process. -![basics](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/astro-ecommerce/astro-ecommerce-1.jpg) +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/). -## Description +This template uses Astro version `2.0.1`. -Introducing **Astro Ecommerce**, the ultimate starter template for your e-commerce web project. Built on Astro's next-gen island architecture, Astro Ecommerce offers a sleek and modern design with a wide range of components and features to help you create a stunning online store. +> **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 Ecommerce project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/astro-ecommerce "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. --- -**Main Features** -Build your e-commerce website quickly and efficiently with: -- 70+ fully coded elements -- 3 fully coded example pages -- 30+ blocks -- Responsive design - -**Example Pages** -We created a set of pre-built pages to help you get inspired or show something to your clients. See them below: -- [Landing Page](https://demos.creative-tim.com/astro-ecommerce/landing/): Designed to introduce the website's purpose and encourage the user to take an action. -- [Product Page](https://demos.creative-tim.com/astro-ecommerce/product/): It's designed to give the user all the information they need to make a purchase decision -- [Shopping Page](https://demos.creative-tim.com/astro-ecommerce/shopping-cart/): Includes a summary of the items in the cart and a form for billing and shipping information. -- more+ - -Astro Ecommerce has everything you need to create the e-commerce website of your dreams. - - -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -``` -/ -├── public/ -│ └── favicon.svg -├── src/ -│ ├── components/ -│ │ ├── cart/ -│ │ ├── checkout/ -│ │ ├── incentives/ -│ │ ├── order/ -│ │ ├── products/ -│ │ ├── promo/ -│ │ ├── reviews/ -│ │ ├── store/ -│ │ ├── dashboardContext.tsx -│ │ ├── footer.tsx -│ │ └── navbar.tsx -│ ├── layouts/ -│ │ └── Layout.astro -│ └── pages/ -│ ├── index.astro -│ ├── landing.astro -│ ├── product.astro -│ └── shopping-cart.astro -├── package.json -├── README.md -└── tsconfig.json -``` - -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. - -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. - -Any static assets, like images, can be placed in the `public/` directory. +## Deploy your own -## 🧞 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:3000` | -| `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 preview` | -| `npm run astro --help` | Get help using the Astro CLI | - -#### Social Media - -Twitter: - -Facebook: - -Dribbble: - -TikTok: - -Instagram: +Deploy your own Astro Ecommerce project with Azion. -## 👀 Want to learn more? +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/astro-ecommerce "Deploy with Azion") -Feel free to check [our documentation](https://www.creative-tim.com/learning-lab/astro/overview/astro-ecommerce) or jump into our [Discord server](https://discord.com/invite/TGZqBvZB). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From a52b534c73cd42ca4c886484fd5d95ccc7b235fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:28:29 -0300 Subject: [PATCH 53/76] refactor: update readme - Astro with Framework Alpine --- .../astro/astro-framework-alpine/README.md | 32 ++++++++++++------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/templates/astro/astro-framework-alpine/README.md b/templates/astro/astro-framework-alpine/README.md index 60daca31..87a0a145 100644 --- a/templates/astro/astro-framework-alpine/README.md +++ b/templates/astro/astro-framework-alpine/README.md @@ -1,22 +1,32 @@ -# Astro + AlpineJS Example +# Astro with Framework Alpine -```sh -npm create astro@latest -- --template framework-alpine -``` +The **Astro with Framework Alpine** template deploys a new edge application based on Astro working with Alpine.js. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-alpine) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-alpine) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-alpine/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro working with [AlpineJS](https://alpinejs.dev/). +This template uses Astro version `4.5.12` and Alpine version `3.13.5`. + +> **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. + +--- + +## Requirements + +Before using this template, you need to: + +- 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. --- -## Deploy Your Own +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-alpine "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From ffb8c710efef911d63f6ac8eedd4dc5d8082cdd7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:48:23 -0300 Subject: [PATCH 54/76] refactor: update readme - Astro with Framework Lit --- .../astro/astro-framework-alpine/README.md | 2 +- templates/astro/astro-framework-lit/README.md | 33 ++++++++++++------- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/templates/astro/astro-framework-alpine/README.md b/templates/astro/astro-framework-alpine/README.md index 87a0a145..80dd257e 100644 --- a/templates/astro/astro-framework-alpine/README.md +++ b/templates/astro/astro-framework-alpine/README.md @@ -19,7 +19,7 @@ Before using this template, you need to: - 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. +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. --- diff --git a/templates/astro/astro-framework-lit/README.md b/templates/astro/astro-framework-lit/README.md index 7720a4fc..2bbcd3c8 100644 --- a/templates/astro/astro-framework-lit/README.md +++ b/templates/astro/astro-framework-lit/README.md @@ -1,22 +1,33 @@ -# Astro + Lit Example +# Astro with Framework Lit -```sh -npm create astro@latest -- --template framework-lit -``` +The **Astro with Framework Lit** template deploys a new edge application based on Astro working with Lit. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-lit) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-lit) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-lit/devcontainer.json) +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/use-a-template-via-azion-console/). + +This template uses Astro version `4.5.12` and Lit 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. -This example showcases Astro working with [Lit](https://lit.dev/). --- -## Deploy Your Own +## Requirements + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-lit "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 26b41b4834dda96a6399a599410ddeba0f0f8c9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:27:54 -0300 Subject: [PATCH 55/76] refactor: update readme - Astro with Multiple Frameworks --- templates/astro/astro-framework-lit/README.md | 1 - .../astro/astro-framework-multiple/README.md | 32 ++++++++++++------- 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/templates/astro/astro-framework-lit/README.md b/templates/astro/astro-framework-lit/README.md index 2bbcd3c8..6f25b0d1 100644 --- a/templates/astro/astro-framework-lit/README.md +++ b/templates/astro/astro-framework-lit/README.md @@ -10,7 +10,6 @@ This template uses Astro version `4.5.12` and Lit version `3.1.2`. > > 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. - --- ## Requirements diff --git a/templates/astro/astro-framework-multiple/README.md b/templates/astro/astro-framework-multiple/README.md index b61b6b53..5a5fc4d4 100644 --- a/templates/astro/astro-framework-multiple/README.md +++ b/templates/astro/astro-framework-multiple/README.md @@ -1,24 +1,32 @@ -# Kitchen Sink: Microfrontends with Astro +# Astro with Multiple Frameworks -```sh -npm create astro@latest -- --template framework-multiple -``` +The **Astro with Multiple Frameworks** template showcases Astro's built-in support for multiple frameworks (React, Preact, Svelte, and Vue). By using this template, no configuration is needed to enable these frameworks, just start writing components in src/components. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-multiple) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-multiple) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-multiple/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro's built-in support for multiple frameworks ([React](https://react.dev), [Preact](https://preactjs.com), [Svelte](https://svelte.dev), and [Vue (`v3.x`)](https://v3.vuejs.org/)). +This template uses Astro version `4.5.12`, React version `18.2.0`, Preact version `10.19.2`, Svelte version `4.2.5`, and Vue version `3.3.8`. -No configuration is needed to enable these frameworks—just start writing components in `src/components`. +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-multi "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 9b185dd9a4cfa9305988989865363fd5b707c06c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:34:49 -0300 Subject: [PATCH 56/76] refactor: update readme - Astro with Framework Preact --- .../astro/astro-framework-preact/README.md | 32 ++++++++++++------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/templates/astro/astro-framework-preact/README.md b/templates/astro/astro-framework-preact/README.md index 2ecf7419..e2adae19 100644 --- a/templates/astro/astro-framework-preact/README.md +++ b/templates/astro/astro-framework-preact/README.md @@ -1,24 +1,32 @@ -# Astro + Preact Example +# Astro with Framework Preact -```sh -npm create astro@latest -- --template framework-preact -``` +The **Astro with Framework Preact** template deploys a new edge application based on Astro working with Preact. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-preact) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-preact) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-preact/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro working with [Preact](https://preactjs.com). +This template uses Astro version `4.5.12` and Preact version `10.19.2`. -Write your Preact components as `.jsx` or `.tsx` files in your project. +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-preact "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). From cdea214c1a97342e1eb5e03909811f3fca80e2ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:43:47 -0300 Subject: [PATCH 57/76] refactor: update readme - Astro with Framework React --- .../astro/astro-framework-react/README.md | 32 ++++++++++++------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/templates/astro/astro-framework-react/README.md b/templates/astro/astro-framework-react/README.md index dba42a7d..0a3dd30c 100644 --- a/templates/astro/astro-framework-react/README.md +++ b/templates/astro/astro-framework-react/README.md @@ -1,24 +1,32 @@ -# Astro + React Example +# Astro with Framework React -```sh -npm create astro@latest -- --template framework-react -``` +The **Astro with Framework React** template deploys a new edge application based on Astro working with React. Using this template, you can write your React components as .jsx or .tsx files in your project. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-react) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-react) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-react/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro working with [React](https://react.dev). +This template uses Astro version `4.5.12` and React version `18.2.0`. -Write your React components as `.jsx` or `.tsx` files in your project. +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-react "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 2a12da49e938369ea215da9db4de82ed569e8228 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:44:21 -0300 Subject: [PATCH 58/76] refactor: update readme - Astro with Framework Solid --- .../astro/astro-framework-solid/README.md | 32 ++++++++++++------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/templates/astro/astro-framework-solid/README.md b/templates/astro/astro-framework-solid/README.md index 435de375..09f7f411 100644 --- a/templates/astro/astro-framework-solid/README.md +++ b/templates/astro/astro-framework-solid/README.md @@ -1,24 +1,32 @@ -# Astro + Solid.js Example +# Astro with Framework Solid -```sh -npm create astro@latest -- --template framework-solid -``` +The **Astro with Framework Solid** template deploys a new edge application based on Astro working with Solid. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-solid) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-solid) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-solid/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro working with [Solid](https://www.solidjs.com/). +This template uses Astro version `4.5.12` and Solid version `1.8.5`. -Write your Solid components as `.jsx` or `.tsx` files in your project. +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-solid "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 9025f6a1aabe91aa6f4127378c1ba48fd8b6e3fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:47:53 -0300 Subject: [PATCH 59/76] refactor: update readme - Astro with Framework Svelte --- .../astro/astro-framework-svelte/README.md | 32 ++++++++++++------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/templates/astro/astro-framework-svelte/README.md b/templates/astro/astro-framework-svelte/README.md index e5bd69e3..cc777377 100644 --- a/templates/astro/astro-framework-svelte/README.md +++ b/templates/astro/astro-framework-svelte/README.md @@ -1,22 +1,32 @@ -# Astro + Svelte Example +# Astro with Framework Svelte -```sh -npm create astro@latest -- --template framework-svelte -``` +The **Astro with Framework Svelte** template deploys a new edge application based on Astro working with Svelte. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-svelte) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-svelte) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-svelte/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro working with [Svelte](https://svelte.dev/). +This template uses Astro version `4.5.12` and Svelte version `4.2.5`. + +> **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. + +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and [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. --- -## Deploy Your Own +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-svelte "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 8969e15f2040dddba58a8fc45bfad7a19514b891 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:50:59 -0300 Subject: [PATCH 60/76] refactor: update readme - Astro with Framework Vue --- templates/astro/astro-framework-vue/README.md | 30 ++++++++++++------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/templates/astro/astro-framework-vue/README.md b/templates/astro/astro-framework-vue/README.md index 0d6aa739..6e61b57d 100644 --- a/templates/astro/astro-framework-vue/README.md +++ b/templates/astro/astro-framework-vue/README.md @@ -1,14 +1,25 @@ -# Astro + Vue Example +# Astro with Framework Vue -```sh -npm create astro@latest -- --template framework-vue -``` +The **Astro with Framework Vue** template deploys a new edge application based on Astro working with Vue. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-vue) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-vue) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-vue/devcontainer.json) +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/use-a-template-via-azion-console/). -This example showcases Astro working with [Vue](https://v3.vuejs.org/). +This template uses Astro version `4.5.12` and Vue version `4.0.9`. + +> **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. + +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and [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. --- @@ -18,5 +29,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-framework-vue "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From cdc0ed2efc86c1ab1f51a72b8a03de4dac735d6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:55:42 -0300 Subject: [PATCH 61/76] refactor: update readme - Astro Minimal --- templates/astro/astro-minimal/README.md | 61 +++++++------------------ 1 file changed, 17 insertions(+), 44 deletions(-) diff --git a/templates/astro/astro-minimal/README.md b/templates/astro/astro-minimal/README.md index 0d698e9b..f4fa4d5c 100644 --- a/templates/astro/astro-minimal/README.md +++ b/templates/astro/astro-minimal/README.md @@ -1,59 +1,32 @@ -# Astro Starter Kit: Minimal +# Astro Minimal -```sh -npm create astro@latest -- --template minimal -``` +The **Astro Minimal** template is a minimal template to start a new Astro project. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json) +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/use-a-template-via-azion-console/). -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! - ---- - -## Deploy Your Own - -Deploy your own Astro project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-minimal "Deploy with Azion") +This template uses Astro version `4.5.12`. +> **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. --- +## Requirements -## 🚀 Project Structure +Before using this template, you need to: -Inside of your Astro project, you'll see the following folders and files: +- 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. -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json -``` +> **Note**: this template uses [Application Accelerator](https://www.azion.com/en/documentation/products/build/edge-application/application-accelerator/) and [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. -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. - -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. - -Any static assets, like images, can be placed in the `public/` directory. - -## 🧞 Commands +--- -All commands are run from the root of the project, from a terminal: +## Deploy your own -| 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 Astro project with Azion. -## 👀 Want to learn more? +[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-minimal "Deploy with Azion") -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). From 46c2070ef706d3ff9448b00e5c4ac05f68e5befd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:07:52 -0300 Subject: [PATCH 62/76] refactor: update readme - Astro with Non-HTML Pages --- .../astro/astro-non-html-pages/README.md | 63 +++++-------------- 1 file changed, 16 insertions(+), 47 deletions(-) diff --git a/templates/astro/astro-non-html-pages/README.md b/templates/astro/astro-non-html-pages/README.md index c875b708..fb54c06d 100644 --- a/templates/astro/astro-non-html-pages/README.md +++ b/templates/astro/astro-non-html-pages/README.md @@ -1,63 +1,32 @@ -# Astro Starter Kit: Non-HTML Pages +# Astro with Non-HTML Pages -Documentation for "Non-HTML Pages": +The **Astro with Non-HTML Pages** template helps you to deploy an edge application based on Astro able to work with Non-HTML pages. -https://docs.astro.build/en/core-concepts/endpoints/#static-file-endpoints +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/use-a-template-via-azion-console/). -```sh -npm create astro@latest -- --template non-html-pages -``` +This template uses Astro version `4.5.12`. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/non-html-pages) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/non-html-pages) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/non-html-pages/devcontainer.json) - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +> **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 project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-non-html-pages "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/) and [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. --- -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -│ └── about.json.ts -└── package.json -``` - -Astro looks for `.astro`, `.js` or `.ts` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +## Deploy your own -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. - -Any static assets, like images, can be placed in the `public/` directory. - -## 🧞 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 Astro project with Azion. -## 👀 Want to learn more? +[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-non-html-pages "Deploy with Azion") -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From a776f9c2385d87ea993535a9bf269b819e42bbc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:14:10 -0300 Subject: [PATCH 63/76] refactor: update readme - Astro Portfolio --- templates/astro/astro-portfolio/README.md | 41 +++++++++-------------- 1 file changed, 16 insertions(+), 25 deletions(-) diff --git a/templates/astro/astro-portfolio/README.md b/templates/astro/astro-portfolio/README.md index 156c4eda..744f090d 100644 --- a/templates/astro/astro-portfolio/README.md +++ b/templates/astro/astro-portfolio/README.md @@ -1,41 +1,32 @@ -# Astro Starter Kit: Portfolio +# Astro Portfolio -```sh -npm create astro@latest -- --template portfolio -``` +The **Astro Portfolio** template helps you to create your online portfolio using an Astro-based example. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/portfolio) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/portfolio) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/portfolio/devcontainer.json) +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/use-a-template-via-azion-console/). -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +This template uses Astro version `4.5.12`. -![portfolio](https://user-images.githubusercontent.com/357379/210779178-a98f0fb7-6b1a-4068-894c-8e1403e26654.jpg) +> **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 project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-portfolio "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/) and [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. --- -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: +## Deploy your own -| 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 Astro project with Azion. -## 👀 Want to learn more? +[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-portfolio "Deploy with Azion") -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 3d5565cac37f2c8cf531fd23ce01540b7725e242 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:20:49 -0300 Subject: [PATCH 64/76] refactor: update readme - Astro Quickstore --- templates/astro/astro-quickstore/README.md | 79 +++++----------------- 1 file changed, 17 insertions(+), 62 deletions(-) diff --git a/templates/astro/astro-quickstore/README.md b/templates/astro/astro-quickstore/README.md index 90427f16..cae37120 100644 --- a/templates/astro/astro-quickstore/README.md +++ b/templates/astro/astro-quickstore/README.md @@ -1,77 +1,32 @@ -# Astro & Tailwind CSS Starter Kit +# Astro Quickstore -by https://lexingtonthemes.com +The **Astro Quickstore** helps you rapidly set up and deploy on the edge using the Astro framework and Tailwind CSS. -## License +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 is open-source software licensed under the [GPL-3.0 license](https://opensource.org/licenses/GPL-3.0). Feel free to fork, modify, and use it in your projects. - ---- - -## Deploy Your Own - -Deploy your own Astro Quickstore project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/astro-quickstore "Deploy with Azion") +This template uses Tailwind CSS version `4.0.0-alpha.23` and Astro version `4.15.4`. +> **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. --- -## Need an attribution-free version? - -Checkout [Lexington Themes](https://lexingtonthemes.com/) for free and premium multipage themes & UI Kits -For freelancers, developers, businesses, and personal use. -Beautifully crafted with Astro.js, and Tailwind CSS — Simple & easy to customise. +## Requirements -## This template is using Tailwind CSS V4 +Before using this template, you need to: -Now we are using only a CSS file. It's called `global.css` and it's located in the src/styles folder. Now we are eimporting Tailwind CSS on the same file instead of using the `tailwind.config.cjs` file. Like this: +- 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. -```css -// Importing Tailwind CSS -@import "tailwindcss"; -// Importing Tailwind plugins -@plugin "@tailwindcss/typography"; -@plugin "@tailwindcss/forms"; -``` +> **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. -Then to add your styles you will use the @theme directive. Like this: +--- -```css -@theme { - /* Your CSS goes here, see how styles are written on the global.css file */ -} -``` +## Deploy your own -Remember this is just in Alpha version, so you can use it as you want. Just keep an eye on the changes that Tailwind CSS is going to make. +Deploy your own Astro Quickstore project with Azion. +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/astro-quickstore "Deploy with Azion") -## Template Structure -Inside of your Astro project, you'll see the following folders and files: -``` -/ -├── public/ -├── src/ -│ └── components/ -│ └── layouts/ -│ └── pages/ -│ └── index.astro -│ └── styles/ -└── package.json -``` -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. -Any static assets, like images, can be placed in the `public/` directory. -## 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:3000` | -| `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 | -## Want to learn more? -Feel free to check Astroäs [documentation](https://docs.astro.build) -# quickstore +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From 0d743f16e217705ea37a8feddc599b9367e3c3eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:23:46 -0300 Subject: [PATCH 65/76] refactor: update readme - Astro Starlog --- templates/astro/astro-starlog/README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/templates/astro/astro-starlog/README.md b/templates/astro/astro-starlog/README.md index 1195b376..ffef85f5 100644 --- a/templates/astro/astro-starlog/README.md +++ b/templates/astro/astro-starlog/README.md @@ -1,10 +1,23 @@ -# Starlog +# Astro Starlog -## Release notes theme for Astro +The **Astro Starlog** template helps you to create Release Notes using this theme for Astro. 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/use-a-template-via-azion-console/). -![starlog-gh](https://github.com/doodlemarks/starlog/assets/2244813/9c5c2e46-665a-437e-a971-053db4dbff63) +This template uses Astro version `4.5.12`. -Built with Astro and Sass. Supports both dark and light modes. +> **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. + +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and [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. --- @@ -14,5 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-starlog "Deploy with Azion") - ---- +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From af0bb110d9381dcf1e91a22e85343926266f4d2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:29:17 -0300 Subject: [PATCH 66/76] refactor: update readme - Astro with Markdoc --- templates/astro/astro-with-markdoc/README.md | 67 +++++--------------- 1 file changed, 15 insertions(+), 52 deletions(-) diff --git a/templates/astro/astro-with-markdoc/README.md b/templates/astro/astro-with-markdoc/README.md index 4e779d1e..10930581 100644 --- a/templates/astro/astro-with-markdoc/README.md +++ b/templates/astro/astro-with-markdoc/README.md @@ -1,67 +1,30 @@ -# Astro Example: Markdoc (experimental) +# Astro with Markdoc -This starter showcases the experimental Markdoc integration. +The **Astro with Markdoc** template deploys a new edge application based on Astro working with the experimental Markdoc integration. 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/use-a-template-via-azion-console/). -```sh -npm create astro@latest -- --template with-markdoc -``` +This template uses Astro version `4.5.12`. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdoc) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdoc) - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +> **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 project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-markdoc "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/) and [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. --- -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -├── src/ -│ └── content/ - └── docs/ -│ └── intro.mdoc -| └── config.ts -│ └── components/Aside.astro -│ └── layouts/Layout.astro -│ └── pages/index.astro -| └── env.d.ts -├── astro.config.mjs -├── markdoc.config.mjs -├── README.md -├── package.json -└── tsconfig.json -``` - -Markdoc (`.mdoc`) files can be used in content collections. See `src/content/docs/` for an example file. +## Deploy your own -You can also render Astro components from your Markdoc files using [tags](https://markdoc.dev/docs/tags). See the `markdoc.config.mjs` file for an example configuration. - -## 🧞 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 Astro project with Azion. -## 👀 Want to learn more? +[![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-markdoc "Deploy with Azion") -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From 504eb17bca29bfed28b652b616dbb31ff3750446 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:32:07 -0300 Subject: [PATCH 67/76] refactor: update readme - Astro Markdown with plugins --- .../astro-with-markdown-plugins/README.md | 30 ++++++++++++------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/templates/astro/astro-with-markdown-plugins/README.md b/templates/astro/astro-with-markdown-plugins/README.md index ce634672..bfa72801 100644 --- a/templates/astro/astro-with-markdown-plugins/README.md +++ b/templates/astro/astro-with-markdown-plugins/README.md @@ -1,22 +1,30 @@ -# Astro Example: Markdown with Plugins +# Astro Markdown with plugins -```sh -npm create astro@latest -- --template with-markdown-plugins -``` +The **Astro Markdown with plugins** template showcases Astro's built-in Markdown support with additional, user-provided plugins. 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/use-a-template-via-azion-console/). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdown-plugins) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdown-plugins) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-markdown-plugins/devcontainer.json) +This template uses Astro version `4.5.12`. -This example showcases Astro's [built-in Markdown support](https://docs.astro.build/en/guides/markdown-content/) with additional, user-provided plugins. +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-markdown-with-plugins "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From 17192f04d9906fa238cb873f7ec7aed941857eb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:34:14 -0300 Subject: [PATCH 68/76] refactor: update readme - Astro Markdown with Shiki --- .../astro/astro-with-markdown-shiki/README.md | 30 +++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/templates/astro/astro-with-markdown-shiki/README.md b/templates/astro/astro-with-markdown-shiki/README.md index 143cf2cc..6493fb0b 100644 --- a/templates/astro/astro-with-markdown-shiki/README.md +++ b/templates/astro/astro-with-markdown-shiki/README.md @@ -1,24 +1,30 @@ -# Astro Example: Markdown with Shiki +# Astro Markdown with Shiki -```sh -npm create astro@latest -- --template with-markdown-shiki -``` +The **Astro Markdown with Shiki** template showcases Astro's built-in Markdown support. 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/use-a-template-via-azion-console/). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdown-shiki) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdown-shiki) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-markdown-shiki/devcontainer.json) +This template uses Astro version `4.5.12`. -This example showcases Astro's [built-in Markdown support](https://docs.astro.build/en/guides/markdown-content/). +> **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. -- `src/pages/index.md` is a treated as a page entrypoint and uses a `layout`. +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and [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. --- -## Deploy Your Own +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-markdown-with-shiki "Deploy with Azion") - ---- \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From 74e653120c7aadb16e14f88bfb7d347db34cb279 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:36:55 -0300 Subject: [PATCH 69/76] refactor: update readme - Astro with MDX --- templates/astro/astro-with-mdx/README.md | 28 +++++++++++++++--------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/templates/astro/astro-with-mdx/README.md b/templates/astro/astro-with-mdx/README.md index 4a08953c..6c58db57 100644 --- a/templates/astro/astro-with-mdx/README.md +++ b/templates/astro/astro-with-mdx/README.md @@ -1,21 +1,29 @@ -# Astro Example: MDX +# Astro with MDX -```sh -npm create astro@latest -- --template with-mdx -``` +The **Astro with MDX** template deploys a new edge application based on Astro, using @astrojs/mdx to author content using MDX. 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/use-a-template-via-azion-console/). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-mdx) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-mdx) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-mdx/devcontainer.json) +This template uses Astro version `4.5.12` and Preact version `10.19.2`. -This example showcases using [`@astrojs/mdx`](https://www.npmjs.com/package/@astrojs/mdx) to author content using [MDX](https://mdxjs.com/). +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-mdx "Deploy with Azion") ---- From acc7ff764bac26b79e7e3bbf8938212ff7c67b23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:37:23 -0300 Subject: [PATCH 70/76] Update README.md --- templates/astro/astro-with-mdx/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/astro/astro-with-mdx/README.md b/templates/astro/astro-with-mdx/README.md index 6c58db57..f34eb3a5 100644 --- a/templates/astro/astro-with-mdx/README.md +++ b/templates/astro/astro-with-mdx/README.md @@ -1,6 +1,6 @@ # Astro with MDX -The **Astro with MDX** template deploys a new edge application based on Astro, using @astrojs/mdx to author content using MDX. 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/use-a-template-via-azion-console/). +The **Astro with MDX** template deploys a new edge application based on Astro, using `@astrojs/mdx` to author content using MDX. 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/use-a-template-via-azion-console/). This template uses Astro version `4.5.12` and Preact version `10.19.2`. From 9298a44f305e9683aa2bb2c3070dcbec26f04e52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:38:43 -0300 Subject: [PATCH 71/76] Update README.md --- templates/astro/astro-with-mdx/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/templates/astro/astro-with-mdx/README.md b/templates/astro/astro-with-mdx/README.md index f34eb3a5..d1d06c3f 100644 --- a/templates/astro/astro-with-mdx/README.md +++ b/templates/astro/astro-with-mdx/README.md @@ -27,3 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-mdx "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From b32130bdbb0b5bbaf53a71dc41a3c315dcbf819e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:41:27 -0300 Subject: [PATCH 72/76] refactor: update readme - Astro with Nano Stores --- .../astro/astro-with-nanostores/README.md | 29 ++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/templates/astro/astro-with-nanostores/README.md b/templates/astro/astro-with-nanostores/README.md index 7247e7f1..5aa0287b 100644 --- a/templates/astro/astro-with-nanostores/README.md +++ b/templates/astro/astro-with-nanostores/README.md @@ -1,21 +1,30 @@ -# Astro Example: Nanostores +# Astro with Nano Stores -```sh -npm create astro@latest -- --template with-nanostores -``` +The **Astro with Nano Stores** template showcases Astro's built-in support for nanostores to provide a shared state between components of any framework. 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/use-a-template-via-azion-console/). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-nanostores) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-nanostores) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-nanostores/devcontainer.json) +This template uses Astro version `4.5.12`, Preact version `10.19.2`, and Nanostores version `0.9.5`. -This example showcases using [`nanostores`](https://github.com/nanostores/nanostores) to provide shared state between components of any framework. [**Read our documentation on sharing state**](https://docs.astro.build/en/core-concepts/sharing-state/) for a complete breakdown of this project, along with guides to use React, Vue, Svelte, or Solid! +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-nanostores "Deploy with Azion") ---- +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file From 5bd59406bee54ec32dbc5be27ca561297a31a225 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:47:00 -0300 Subject: [PATCH 73/76] refactor: update readme - Astro with Tailwind CSS --- templates/astro/astro-starlog/README.md | 2 +- templates/astro/astro-with-markdoc/README.md | 2 +- .../astro-with-markdown-plugins/README.md | 2 +- .../astro/astro-with-markdown-shiki/README.md | 2 +- templates/astro/astro-with-mdx/README.md | 2 +- .../astro/astro-with-nanostores/README.md | 2 +- .../astro/astro-with-tailwindcss/README.md | 29 ++++++++++++------- 7 files changed, 24 insertions(+), 17 deletions(-) diff --git a/templates/astro/astro-starlog/README.md b/templates/astro/astro-starlog/README.md index ffef85f5..bcb254fd 100644 --- a/templates/astro/astro-starlog/README.md +++ b/templates/astro/astro-starlog/README.md @@ -27,4 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-starlog "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file diff --git a/templates/astro/astro-with-markdoc/README.md b/templates/astro/astro-with-markdoc/README.md index 10930581..b816d792 100644 --- a/templates/astro/astro-with-markdoc/README.md +++ b/templates/astro/astro-with-markdoc/README.md @@ -27,4 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-markdoc "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file diff --git a/templates/astro/astro-with-markdown-plugins/README.md b/templates/astro/astro-with-markdown-plugins/README.md index bfa72801..72a56098 100644 --- a/templates/astro/astro-with-markdown-plugins/README.md +++ b/templates/astro/astro-with-markdown-plugins/README.md @@ -27,4 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-markdown-with-plugins "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file diff --git a/templates/astro/astro-with-markdown-shiki/README.md b/templates/astro/astro-with-markdown-shiki/README.md index 6493fb0b..d2237437 100644 --- a/templates/astro/astro-with-markdown-shiki/README.md +++ b/templates/astro/astro-with-markdown-shiki/README.md @@ -27,4 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-markdown-with-shiki "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file diff --git a/templates/astro/astro-with-mdx/README.md b/templates/astro/astro-with-mdx/README.md index d1d06c3f..4cac4e32 100644 --- a/templates/astro/astro-with-mdx/README.md +++ b/templates/astro/astro-with-mdx/README.md @@ -27,4 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-mdx "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file diff --git a/templates/astro/astro-with-nanostores/README.md b/templates/astro/astro-with-nanostores/README.md index 5aa0287b..0d6f0e21 100644 --- a/templates/astro/astro-with-nanostores/README.md +++ b/templates/astro/astro-with-nanostores/README.md @@ -27,4 +27,4 @@ Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-nanostores "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/astro-ecommerce-collection/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file diff --git a/templates/astro/astro-with-tailwindcss/README.md b/templates/astro/astro-with-tailwindcss/README.md index 7deef32a..e61dfb15 100644 --- a/templates/astro/astro-with-tailwindcss/README.md +++ b/templates/astro/astro-with-tailwindcss/README.md @@ -1,23 +1,30 @@ -# Astro with Tailwind +# Astro with Tailwind CSS -```sh -npm create astro@latest -- --template with-tailwindcss -``` +The **Astro with Tailwind CSS** template deploys a new edge application based on Astro working with Tailwind CSS. 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/use-a-template-via-azion-console/). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-tailwindcss) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-tailwindcss) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-tailwindcss/devcontainer.json) +This template uses Astro version `4.5.12` and Tailwind CSS version `3.3.5`. -Astro comes with [Tailwind](https://tailwindcss.com) support out of the box. This example showcases how to style your Astro project with Tailwind. +> **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. -For complete setup instructions, please see our [Tailwind Integration Guide](https://docs.astro.build/en/guides/integrations-guide/tailwind). +--- + +## Requirements + +Before using this template, you need to: + +- 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/) and [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. --- -## Deploy Your Own +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-tailwind "Deploy with Azion") ---- +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From 1be1e44c3b0e00fb2062eb728e437694f329b08f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:48:58 -0300 Subject: [PATCH 74/76] refactor: update readme - Astro with Vitest --- templates/astro/astro-with-vitest/README.md | 29 ++++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/templates/astro/astro-with-vitest/README.md b/templates/astro/astro-with-vitest/README.md index bbc86f88..99b15562 100644 --- a/templates/astro/astro-with-vitest/README.md +++ b/templates/astro/astro-with-vitest/README.md @@ -1,21 +1,30 @@ -# Astro + [Vitest](https://vitest.dev/) Example +# Astro with Vitest -```sh -npm create astro@latest -- --template with-vitest -``` +The **Astro with Vitest** template deploys a new edge application based on Astro working with Vitest. 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/use-a-template-via-azion-console/). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-vitest) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-vitest) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-vitest/devcontainer.json) +This template uses Astro version `4.5.12` and Vitest version `1.3.1`. -This example showcases Astro working with [Vitest](https://vitest.dev/). +> **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 + +Before using this template, you need to: + +- 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/) and [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. + +--- + +## Deploy your own Deploy your own Astro project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/astro/astro-with-vitest "Deploy with Azion") ---- +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/use-a-template-via-azion-console/). \ No newline at end of file From babc30680ea63153bc7b624f259f2b906ee27c96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:56:29 -0300 Subject: [PATCH 75/76] refactor: update readmes - devscard & web to pdf --- templates/astro/devscard/README.md | 35 +++--- templates/astro/webpage-pdf-resume/README.md | 109 +++---------------- 2 files changed, 28 insertions(+), 116 deletions(-) diff --git a/templates/astro/devscard/README.md b/templates/astro/devscard/README.md index 2007eba4..b5d73785 100644 --- a/templates/astro/devscard/README.md +++ b/templates/astro/devscard/README.md @@ -1,33 +1,28 @@ # DevsCard -A fully customizable template to create your online (and paper) resume without writing a single line of code. +The **DevsCard** template contains the configurations to create your online and paper resume using the DevsCard project. After the deployment, you can update it with your information and create your portfolio. + +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/devscard/). + +This template uses Astro version `4.5.12`. --- -## Deploy Your Own +## Requirements -Deploy your own DevsCard project with Azion. +Before using this template, you need to: -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/devscard "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. -## Features +--- -- **✍️ Intellisense** — provide your data in TypeScript files, getting autocompletion and description of each property right in your IDE. -- **📱 Responsiveness** — the resume is created and automatically tested to look good both on mobile and desktop devices. -- **🌠 Assets optimization** — all images in your CV are minimized and resized automatically at build time. -- **⚡️ Performance** — get 100 for all Lighthouse metrics, ensuring a great experience for visitors and a high score for search engines. -- **📄 PDF generation** — generate an accompanying PDF version of your CV with one command. -- **🔶 Built-in icon sets** — choose from over 100 000 [Iconify](https://iconify.design/) icons to represent your skills. -- **🌍 I18n** — customize your resume's locale, date formatting, and used translations. -- **🔎 SEO friendly** — the entire website is designed with SEO in mind. All SEO-related config properties are required and well-described. -- **🏭 Favicons generation** — invoke one command to generate all favicons and full app manifest for your website. -- **🛠 Data helpers** — use built-in helpers to define your skills/socials once and reuse them across the configuration. -- **🔀 Data transformers** — utilize type-safe data transformers to create multiple variants of your resume without duplicating your data. +## Deploy your own -## Documentation +Deploy your own DevsCard project with Azion. -To learn how to set up your resume, go to: +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/devscard "Deploy with Azion") -[https://devscard.gitbook.io/docs](https://devscard.gitbook.io/docs/setup-guide) +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/devscard/). diff --git a/templates/astro/webpage-pdf-resume/README.md b/templates/astro/webpage-pdf-resume/README.md index de240909..76a2621f 100644 --- a/templates/astro/webpage-pdf-resume/README.md +++ b/templates/astro/webpage-pdf-resume/README.md @@ -1,111 +1,28 @@ # Webpage to PDF Resume -A straightforward resume or CV template for the web, print, or PDF. Built with [Astro](https://astro.build) and [PandaCSS](https://panda-css.com). +The **Webpage to PDF Resume** template contains the configurations to create a resume for the web, print, or PDF using the Webpage to PDF Resume project. After the deployment, you can update it with your information and create your portfolio. ---- - -## Deploy Your Own +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/webpage-to-pdf-resume/). -Deploy your own Webpage to PDF Resume project with Azion. - -[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/webpage-to-pdf-resume "Deploy with Azion") +This template uses Astro version `4.6.1`. --- -## Features - -- Separation of data (name, experience, education, etc) from page templates, allowing you to create different look and feels without copying and pasting your information. -- Supports cover letters to match the resume's aesthetic, using Astro Collections and markdown. -- Built to ship--when deployed, only the homepage resume is built for production and keeping other templates and cover letters in dev-only. -- Job application-ready PDFs from your resume and cover letters. - -## Who's this for? - -As a web developer, I got frustrated with Google Doc templates or resume builder sites that either cost a lot of money or have problems with their designs. When putting together my one-page resume, I knew how I wanted things to look, and I just wanted to use markup and CSS to make it! - -So I built this template to make it easy to bootstrap a readable and tasteful resume. It's structured to look great on the web, and produce a balanced, well-formatted one-pager when saved as a PDF or printed. The personal information is abstracted into JSON to make it easy to create new templates. - -## How to use it - -### Setup - -Fork and clone the repo. Note that [bun](https://bun.sh) is required. - -```sh -# Install dependencies -bun install -# Start development server -bun dev -``` - -### Project Structure - -The `src/` folder has the following files and folders: - -```tree -components/ -content/ -layouts/ -pages/ -templates/ -data.json -``` - -This mostly follows Astro's project structure, with a few additions - -All of the personal information that populates the template is located in `src/data.json`. Update this file with all of your information. This information will be referenced throughout the application. - -Inside the `pages/` directory, we have two entities: `index.astro` and `__letters`. All routes with the double-underscore prefix will not be in the final production bundle. This way, you can create good-looking cover letters that match your resume look and feel without shipping them to production. The `index.astro` should be your resume that lives on the homepage of the site. It will be the only page shipped to production. - -The `templates/` directory will contain the different look and feels you wish to create for your resume and letters. You're welcome to use the provided template or create additional ones. While this isn't necessary for most, it can be nice to have the flexibility to try different resume layouts and aesthetics without having to create a new project. +## Requirements -### Customize Look & Feel +Before using this template, you need to: -The template uses PandaCSS and its [default theme](https://panda-css.com/docs/customization/theme). It gives you all of the base tokens to quickly build out new designs or modify this one. To change the accent color or some of the default styling, update the `panda.config.ts` file. +- 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. -The provided font is [Rubik](https://fontsource.org/fonts/rubik). To change the font, find a font to your liking on [Fontsource](https://fontsource.org) and install it following their instructions. +> **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. -The provided favicon was generated from [favicon.io](https://favicon.io). Use your own favicon, or generate one there, and delete the provided favicon files in `/public`. - -### Cover Letters - -You can write your cover letters in markdown in the `src/content/letters/` directory. Pages for your cover letters are generated in dev, but won't be shipped to production. You can see all of the links to the webpages generated by navigating tot he `/letters/list` route (e.g., `http://localhost:4321/letters/list`). Each cover letter page will have a "View as PDF" button--you can use this to generate the PDF, download it, and upload it for your job application. - -The provided template also includes a cover letter template that matches the resume. - -## Printing - -The structure and content of this resume template is intended to fit onto a single page, suitable for a one-page resume. Depending on your personal information, the length may break onto a second page. I'd recommend futzing with the base font-size in the `src/index.css` file or adjust vertical spacing in the template to make it fit one page. You can also adjust the page margins for printing in the `src/index.css` file. - -To automate the creation of PDFs, this project uses [puppeteer](https://pptr.dev/guides/pdf-generation). Compared to using the browser to create PDFs (through the process of `Print -> Save as PDF`), puppeteer will produce a PDF with machine-readable text and give you the PDF file itself. - -The project includes a pre-push git hook that ensures that the git committed PDF of your resume is up-to-date with the source code. When the project is deployed to production, the PDF file will be present in the project, so it doesn't need to be recreated on the fly (so it also loads faster). - -## Blocking search engines - -Disable search engine indexing by adding the following code to the in `src/layouts/Layout.astro`: - -```html - -``` - -## License - -NonCommercial-ShareAlike 1.0 Generic (CC NC-SA 1.0) -https://creativecommons.org/licenses/nc-sa/1.0/ - -### You are free to: - -Share — copy and redistribute the material in any medium or format - -Adapt — remix, transform, and build upon the material - -### Under the following terms: +--- -NonCommercial — You may not use the material for commercial purposes. +## Deploy your own -ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. +Deploy your own Webpage to PDF Resume project with Azion. -## Acknowledgements +[![Deploy Button](/static/button.png)](https://console.azion.com/create/azion-community/webpage-to-pdf-resume "Deploy with Azion") -Hat-tip to [WebPraktikos/universal-resume](https://github.com/WebPraktikos/universal-resume) for showing what's possible with structuring and adapating a resume webpage for print. This is still a great and relevant project. I wanted to make a slightly different project in order to use web technologies I preferred and to abstract the data so that I could make different templates should I desire it. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/webpage-to-pdf-resume/). \ No newline at end of file From 86493e72b526d83ac1add031561362c396e79962 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20Bellor=C3=ADn=20Aguilera?= <89138244+MarianaAguilera@users.noreply.github.com> Date: Wed, 30 Oct 2024 11:07:00 -0300 Subject: [PATCH 76/76] refactor: add videos links --- templates/javascript/faunadb-boilerplate/README.md | 2 +- templates/javascript/qstash-scheduler/README.md | 2 +- templates/javascript/turso-starter-kit/README.md | 2 +- templates/javascript/upstash-geolocation/README.md | 2 +- templates/javascript/upstash-ratelimit/README.md | 2 +- templates/typescript/azion-atlas/README.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/templates/javascript/faunadb-boilerplate/README.md b/templates/javascript/faunadb-boilerplate/README.md index 2dfd4bc9..f80be0d0 100644 --- a/templates/javascript/faunadb-boilerplate/README.md +++ b/templates/javascript/faunadb-boilerplate/README.md @@ -27,4 +27,4 @@ Deploy your own Fauna project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/fauna/faunadb-boilerplate "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/faunadb-boilerplate/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/faunadb-boilerplate/). You can also learn how to deploy this template by watching [this video](https://youtu.be/QqVUr6RKCnY?feature=shared) on Azion's YouTube channel. \ No newline at end of file diff --git a/templates/javascript/qstash-scheduler/README.md b/templates/javascript/qstash-scheduler/README.md index 404f9339..ccdcb75e 100644 --- a/templates/javascript/qstash-scheduler/README.md +++ b/templates/javascript/qstash-scheduler/README.md @@ -25,4 +25,4 @@ Deploy your own QStash project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/qstash-edgefunction-scheduler "Deploy with Azion") -For a more detailed step-by-step on deploying this template and scheduling tasks, check the [documentation](https://www.azion.com/en/documentation/products/guides/qstash-edge-function-scheduler/). \ No newline at end of file +For a more detailed step-by-step on deploying this template and scheduling tasks, check the [documentation](https://www.azion.com/en/documentation/products/guides/qstash-edge-function-scheduler/). You can also learn how to deploy this template by watching [this video](https://youtu.be/jgphK-DnI80?feature=shared) on Azion's YouTube channel. \ No newline at end of file diff --git a/templates/javascript/turso-starter-kit/README.md b/templates/javascript/turso-starter-kit/README.md index 364120f1..7c5a625f 100644 --- a/templates/javascript/turso-starter-kit/README.md +++ b/templates/javascript/turso-starter-kit/README.md @@ -26,4 +26,4 @@ Deploy your own Turso project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/turso/turso-starter-kit "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/turso-starter-kit/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/turso-starter-kit/). You can also learn how to deploy this template by watching [this video](https://youtu.be/YkZoJ-EQBH0?feature=shared) on Azion's YouTube channel. \ No newline at end of file diff --git a/templates/javascript/upstash-geolocation/README.md b/templates/javascript/upstash-geolocation/README.md index 777d59ea..936b0ec9 100644 --- a/templates/javascript/upstash-geolocation/README.md +++ b/templates/javascript/upstash-geolocation/README.md @@ -28,4 +28,4 @@ Deploy your own Upstash project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/upstash-geolocation "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/upstash-geolocation-edgedeploy/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/upstash-geolocation-edgedeploy/). You can also learn how to deploy this template by watching [this video](https://youtu.be/ZvearWi5Vis?feature=shared) on Azion's YouTube channel. \ No newline at end of file diff --git a/templates/javascript/upstash-ratelimit/README.md b/templates/javascript/upstash-ratelimit/README.md index 6d67e37f..7691b6ac 100644 --- a/templates/javascript/upstash-ratelimit/README.md +++ b/templates/javascript/upstash-ratelimit/README.md @@ -27,4 +27,4 @@ Deploy your own Upstash project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/upstash/upstash-ratelimit "Deploy with Azion") -For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/upstash-rate-limiting/). \ No newline at end of file +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/upstash-rate-limiting/). You can also learn how to deploy this template by watching [this video](https://youtu.be/sHLE7l2qwCc?feature=shared) on Azion's YouTube channel. \ No newline at end of file diff --git a/templates/typescript/azion-atlas/README.md b/templates/typescript/azion-atlas/README.md index 1370116c..5b0be890 100644 --- a/templates/typescript/azion-atlas/README.md +++ b/templates/typescript/azion-atlas/README.md @@ -26,4 +26,4 @@ Deploy your own MongoDB Atlas project with Azion. [![Deploy Button](/static/button.png)](https://console.azion.com/create/mongodb-atlas/mongodb-atlas "Deploy with Azion") -For a more detailed step-by-step on using this template, check the [How to deploy the MongoDB Atlas Boilerplate](https://www.azion.com/en/documentation/products/guides/mongodb-atlas/) guide. You can also learn how to deploy this template by watching [this video](https://www.youtube.com/watch?v=pKv8c0RNbGY&list=PL02NW2s3y10OR8Vw4hsth3TLw4R7VE094&index=6&pp=iAQB) on Azion's YouTube channel. \ No newline at end of file +For a more detailed step-by-step on using this template, check the [How to deploy the MongoDB Atlas Boilerplate](https://www.azion.com/en/documentation/products/guides/mongodb-atlas/) guide. You can also learn how to deploy this template by watching [this video](https://www.youtube.com/watch?v=pKv8c0RNbGY&list=PL02NW2s3y10OR8Vw4hsth3TLw4R7VE094&index=6&pp=iAQB) on Azion's YouTube channel. \ No newline at end of file