From 9653ad9d8af06dee08784ad9635dd8311effef9f Mon Sep 17 00:00:00 2001 From: MarianaReisAlcantara Date: Wed, 22 Jan 2025 16:45:50 -0300 Subject: [PATCH] feat:new-sanity-readme-files (#218) --- .../angular/sanity-angular-clean/README.md | 32 +++++++------ templates/astro/sanity-astro-clean/README.md | 46 +++++++------------ templates/nuxt/sanity-nuxt-clean/README.md | 45 +++++++----------- 3 files changed, 51 insertions(+), 72 deletions(-) diff --git a/templates/angular/sanity-angular-clean/README.md b/templates/angular/sanity-angular-clean/README.md index 9cd40024..850faf48 100644 --- a/templates/angular/sanity-angular-clean/README.md +++ b/templates/angular/sanity-angular-clean/README.md @@ -1,29 +1,31 @@ -# Angular +# Clean Angular + Sanity application -This directory is a brief example of an [Angular](https://angular.io/) app. +The **Clean Angular + Sanity application** template creates an [Angular](https://angular.dev/overview) application with a [Sanity Studio](http://sanity.io/), which is an open-source React application that connects to your Sanity project’s hosted dataset. The Studio is configured locally and can then be deployed for content collaboration. -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.0.1 +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 a web application based on Clean Angular + Sanity application](https://www.azion.com//en/documentation/products/guides/clean-angular-sanity/) guide. -## Development server +This template uses Angular version `16.0.1`. -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. +--- -## Code scaffolding +## Requirements -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. +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. +- A [Sanity.io](http://sanity.io/) account. -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. +> **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. -## Running unit tests +Fill in the fields presented on the configuration form and deploy the template. This 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. -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). +--- -## Running end-to-end tests +## Deploy your own -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. +Deploy your own Clean Angular + Sanity application project with Azion. -## Further help +[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/sanity/clean-angular-sanity-app "Deploy with Azion") -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/clean-angular-sanity/). \ No newline at end of file diff --git a/templates/astro/sanity-astro-clean/README.md b/templates/astro/sanity-astro-clean/README.md index e518949a..8fbaa4ca 100644 --- a/templates/astro/sanity-astro-clean/README.md +++ b/templates/astro/sanity-astro-clean/README.md @@ -1,43 +1,31 @@ -# A minimal Astro site with Sanity Studio +# Clean Astro + Sanity application -This starter uses [Astro](https://astro.build/) for the front end and [Sanity](https://sanity.io/) to handle its content. +The **Clean Astro + Sanity application** template creates a minimal [Astro](https://docs.astro.build/en/concepts/why-astro/) website integrated with Sanity.io for content management. -## Featuring +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 a web application based on Clean Astro + Sanity application](https://www.azion.com//en/documentation/products/guides/clean-astro-sanity/) guide. -- How to fetch content as data from [the Sanity Content Lake](https://www.sanity.io/docs/datastore) -- How to render block content with [Portable Text](https://www.sanity.io/docs/presenting-block-text) -- A [Sanity Studio](https://www.sanity.io/docs/sanity-studio) to create and edit content -- How to crop and render images with [Sanity Image URLs](https://www.sanity.io/docs/presenting-images) +This template uses Astro version `3.1.4`. -## Prerequisites +--- -- [Node.js](https://nodejs.org/en/) (v16.12 or later) +## Requirements -## Getting started +Before using this template, you need to: -Run the following commands +- 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. +- A [Sanity.io](http://sanity.io/) account. -1. `npm install` to install dependencies -2. `npx sanity@latest init --env`, this will: +> **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. - - ask you to select or create a Sanity project and dataset - - output a `.env` file with appropriate variables - - _(or use `sanity init --env` if you have the CLI installed)_ +Fill in the fields presented on the configuration form and deploy the template. This 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. -3. `npm run dev` to start the development server +--- -Your Astro app should now be running on [http://localhost:4321/](http://localhost:4321/) and Studio on [http://localhost:4321/admin](http://localhost:4321/admin). +## Deploy your own -### Add content +Deploy your own Clean Astro + Sanity application project with Azion. -1. Visit the Studio and create and publish a new `Post` document -2. Visit the homepage and refresh the page to see your content rendered on the page - -The schema for the `Post` document is defined in the `/schema` folder. You can [add more document types](https://www.sanity.io/docs/schema-types) to the Studio to suit your needs. - -## Removing TypeScript - -If you do not wish to use TypeScript, we've included a `remove-typescript.mjs` file in the root of this repository. You can run this file with `node remove-typescript.mjs` to strip all types from this project. Please run this before tampering with any code to ensure that all types are properly removed. - -If you intend to use TypeScript, you can safely remove the `remove-typescript.mjs` file. +[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/sanity/clean-astro-sanity-app "Deploy with Azion") +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/clean-astro-sanity/). \ No newline at end of file diff --git a/templates/nuxt/sanity-nuxt-clean/README.md b/templates/nuxt/sanity-nuxt-clean/README.md index fa00c266..8533d58f 100644 --- a/templates/nuxt/sanity-nuxt-clean/README.md +++ b/templates/nuxt/sanity-nuxt-clean/README.md @@ -1,42 +1,31 @@ -# Nuxt 3 Minimal Starter +# Clean Nuxt + Sanity application -Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. +The **Clean Nuxt + Sanity application** template creates a minimal [Nuxt](https://nuxt.com/docs/getting-started/introduction) application with a [Sanity Studio](http://sanity.io/), which is an open-source React application that connects to your Sanity project’s hosted dataset. The Studio is configured locally and can then be deployed for content collaboration. -## Setup +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 a web application based on Clean Nuxt + Sanity application](https://www.azion.com/en/documentation/products/guides/clean-nuxt-sanity/) guide. -Make sure to install the dependencies: +This template uses Nuxt version `3.12.3`. -```bash -# yarn -yarn install +--- -# npm -npm install +## Requirements -# pnpm -pnpm install -``` +Before using this template, you need to: -## Development Server +- 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. +- A [Sanity.io](http://sanity.io/) account. -Start the development server on `http://localhost:3000` +> **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. -```bash -npm run dev -``` +Fill in the fields presented on the configuration form and deploy the template. This 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. -## Production +--- -Build the application for production: +## Deploy your own -```bash -npm run build -``` +Deploy your own Clean Nuxt + Sanity application project with Azion. -Locally preview production build: +[![Deploy Button](https://www.azion.com/button/)](https://console.azion.com/create/sanity/clean-nuxt-sanity-app/ "Deploy with Azion") -```bash -npm run preview -``` - -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. +For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/clean-nuxt-sanity/). \ No newline at end of file