-
Notifications
You must be signed in to change notification settings - Fork 318
#84 Nuxt tutorial #243
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
gewenyu99
merged 4 commits into
appwrite:feat-nuxt-tutorial
from
evelinabe:issue84-nuxt-tutorial
Nov 17, 2023
Merged
#84 Nuxt tutorial #243
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <script lang="ts"> | ||
| import { globToTutorial } from '$lib/utils/tutorials.js'; | ||
| import { setContext } from 'svelte'; | ||
|
|
||
| export let data; | ||
| const tutorials = globToTutorial(data); | ||
| setContext('tutorials', tutorials); | ||
| </script> | ||
|
|
||
| <slot /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import type { LayoutLoad } from './$types'; | ||
|
|
||
| export const load: LayoutLoad = ({ url }) => { | ||
| const tutorials = import.meta.glob('./**/*.markdoc', { | ||
| eager: true | ||
| }); | ||
| return { | ||
| tutorials, | ||
| pathname: url.pathname | ||
| }; | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { redirect } from '@sveltejs/kit'; | ||
| import type { PageLoad } from './$types'; | ||
|
|
||
| export const load: PageLoad = async () => { | ||
| throw redirect(303, '/docs/tutorials/nuxt/step-1'); | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| layout: tutorial | ||
| title: Build an ideas tracker with Nuxt | ||
| description: Learn to build an idea tracker app with Appwrite and Nuxt with authentication, databases and collections, queries, pagination, and file storage. | ||
| step: 1 | ||
| difficulty: beginner | ||
| readtime: 12 | ||
| back: /docs | ||
| --- | ||
|
|
||
| **Idea tracker**: an app to track all the side project ideas that you'll start, but probably never finish. | ||
| In this tutorial, you will build Idea tracker with Appwrite and Nuxt. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| # Concepts {% #concepts %} | ||
|
|
||
| This tutorial will introduce the following concepts: | ||
|
|
||
| 1. Setting up your first project | ||
| 2. Authentication | ||
| 3. Navigation | ||
| 4. Databases and collections | ||
| 5. Queries | ||
|
|
||
|
|
||
| # Prerequisites {% #prerequisites %} | ||
|
|
||
| 1. Basic knowledge of JavaScript. | ||
| 2. Have [Node.js](https://nodejs.org/en) and [NPM](https://www.npmjs.com/) installed on your computer. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| layout: tutorial | ||
| title: Create app | ||
| description: Create a Nuxt app project and integrate with Appwrite | ||
| step: 2 | ||
| --- | ||
|
|
||
| # Create Nuxt project {% #create-nuxt-project %} | ||
|
|
||
| Create a Nuxt app with the `npx init` command. | ||
|
|
||
| ```sh | ||
| npx nuxi@latest init ideas-tracker | ||
| ``` | ||
|
|
||
| # Add dependencies {% #add-dependencies %} | ||
|
|
||
| Install the JavaScript Appwrite SDK. | ||
|
|
||
| ```sh | ||
| npm install appwrite | ||
| ``` | ||
|
|
||
| You can start the development server to watch your app update in the browser as you make changes. | ||
|
|
||
| ```sh | ||
| npm run dev | ||
| ``` | ||
|
|
||
| # Set up files {% #set up-files %} | ||
|
|
||
| In Nuxt, directories help organize the codebase and minimize boilerplate. | ||
| The purpose is making it easy to find and manage different aspect of your application. | ||
|
|
||
| The files added to the `pages` directory will automatically become a route. | ||
| Nuxt will look for a layout in the `layouts` directory to render a page layout. | ||
| Without a layout file in this directory, the routing won't work | ||
| When these files have been created the `app.vue` file needs to edited to render these pages instead of the standard welcome page. | ||
| Then, we will have a working app where we can verify our changes in the browser throughout the tutorial. | ||
| As an additional step, we will be adding [Appwrite's Pink Design system]('https://pink.appwrite.io/') to have a global design system to help with the layout. | ||
|
|
||
| First, add a page by creating the file `src/pages/index.vue` and add the following code. | ||
|
|
||
| ```vue | ||
| <template> | ||
| <div> | ||
| <h1>Hello, idea tracker!</h1> | ||
| </div> | ||
| </template> | ||
| ``` | ||
|
|
||
| Create the file `src/layouts/default.vue` to add the default layout. | ||
|
|
||
| ```vue | ||
| <template> | ||
| <div> | ||
| <slot /> | ||
| </div> | ||
| </template> | ||
|
|
||
| <script> | ||
| export default { | ||
| layout: "default", | ||
| }; | ||
| </script> | ||
| ``` | ||
|
|
||
| Go to `app.vue`, remove `NuxtWelcome`and insert `<NuxtPage />` wrapped inside `<NuxtLayout>`. | ||
|
|
||
| ```vue | ||
| <template> | ||
| <div> | ||
| <NuxtLayout> | ||
| <NuxtPage /> | ||
| </NuxtLayout> | ||
| </div> | ||
| </template> | ||
| ``` | ||
|
|
||
| To import Appwrite's design system to all pages and components, edit the file `nuxt.config.ts`. | ||
| The layouts is then ready to be used in the templates with auto-import. | ||
|
|
||
| ```ts | ||
| export default defineNuxtConfig({ | ||
| app: { | ||
| head: { | ||
| link: [ | ||
| { rel: "stylesheet", href: "https://unpkg.com/@appwrite.io/pink" }, | ||
| { | ||
| rel: "stylesheet", | ||
| href: "https://unpkg.com/@appwrite.io/pink-icons", | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| devtools: { enabled: true }, | ||
| }); | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| layout: tutorial | ||
| title: Set up Appwrite | ||
| description: Import and configure a project with Appwrite Cloud. | ||
| step: 3 | ||
| --- | ||
|
|
||
| # Create project {% #create-project %} | ||
|
|
||
| Head to the [Appwrite Console](https://cloud.appwrite.io/console). | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| If this is your first time using Appwrite, create an account and create your first project. | ||
|
|
||
| Then, under **Add a platform**, add a **Web app**. | ||
| The **Hostname** should be localhost. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| You can skip the optional steps. | ||
|
|
||
| # Initialize Appwrite SDK {% #init-sdk %} | ||
|
|
||
| To use Appwrite in our app, we'll need to find our project ID. | ||
| It is located in the **Settings** page. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| Create a new file `src/appwrite.js` for the Appwrite related code. | ||
| Only one instance of the `Client()` class should be created per app. | ||
| Add the following code to it, replacing `<YOUR_PROJECT_ID>` with your project ID. | ||
|
|
||
| ```js | ||
| import { Client, Databases, Account } from "appwrite"; | ||
|
|
||
| const client = new Client(); | ||
| client | ||
| .setEndpoint("https://cloud.appwrite.io/v1") | ||
| .setProject("<YOUR_PROJECT_ID>"); // Replace with your project ID | ||
|
|
||
| export const account = new Account(client); | ||
| export const database = new Databases(client); | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.