Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

[EDU-5617] Update Nuxt Notes readme #168

Merged
merged 1 commit into from
Nov 8, 2024
Merged

[EDU-5617] Update Nuxt Notes readme #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions templates/nuxt/nuxt3-notes-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
# Nuxt 3 notes app
# Nuxt Notes

Live static site: [http://nuxt3-vue-quill.s3-website-eu-west-1.amazonaws.com/](http://nuxt3-vue-quill.s3-website-eu-west-1.amazonaws.com/)
The **Nuxt Notes** template launches a basic note taking application with [Nuxt](https://nuxt.com/docs/getting-started/introduction), which stores the notes in the user's browser by using [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).

Built with:
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 Nuxt Notes template](https://www.azion.com/en/documentation/products/guides/nuxt-notes/) guide.

- [nuxt 3](https://github.com/nuxt/framework)
- [vue-quill](https://github.com/vueup/vue-quill)
- [tailwind](https://github.com/tailwindlabs/tailwindcss)
- [localforage](https://github.com/localForage/localForage)
This template uses Nuxt `3.0.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.

Don't write any serious notes here, I built this in a few hours using vue-quill, all I did was use localstorage to save notes client side.
---

## 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 Nuxt Notes project with Azion.

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

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