Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
5add472
Fix some links and formatting
Sep 22, 2023
22f7bb9
Fix some title cases
Sep 22, 2023
183a2d8
Add response codes
Sep 23, 2023
b2ebc7e
add message templates under platform
Sep 23, 2023
7904994
Fix some links in the docs
Sep 23, 2023
29b0125
Fix more links
Sep 24, 2023
43ba4c7
Add images that were todos
Sep 24, 2023
da721d5
Add images for self-hosting
Sep 24, 2023
7203076
Merge branch 'main' into feat-docs-g2
Sep 24, 2023
f7b54a1
Updated quick starts final step
eldadfux Sep 25, 2023
33ae452
Merge branch 'main' of https://github.com/appwrite/website into feat-…
TorstenDittmann Sep 25, 2023
7a102cb
Fixed more screenshots
Sep 25, 2023
f3c420c
Merge branch 'feat-docs-g2' of https://github.com/appwrite/website in…
Sep 25, 2023
0da1e5d
fix: dead links
TorstenDittmann Sep 25, 2023
001d23a
Merge branch 'feat-docs-g2' of https://github.com/appwrite/website in…
TorstenDittmann Sep 25, 2023
1b10e22
Merge remote-tracking branch 'origin/main' into feat-docs-g2
abnegate Sep 25, 2023
e750c4e
Update flutter to be one file!
Sep 25, 2023
36d6926
add references
Sep 25, 2023
cdbfb78
Add android quickstart
abnegate Sep 25, 2023
249d89d
Move response code, fix links and sidebar format
Sep 26, 2023
0526c1a
Merge branch 'feat-docs-g2' of https://github.com/appwrite/website in…
Sep 26, 2023
02ff8bc
Fix formatting on webhooks
Sep 26, 2023
951101a
Add Apple quick start
abnegate Sep 26, 2023
01b2654
add place holders in quickstarts taht aren't done yet
Sep 26, 2023
572f9f8
Merge remote-tracking branch 'origin/feat-android-quickstart' into fe…
abnegate Sep 26, 2023
a3dace1
Merge remote-tracking branch 'origin/feat-apple-quickstart' into feat…
abnegate Sep 26, 2023
643a7b7
Update quickstart names to be consistent
Sep 26, 2023
474008e
Merge branch 'main' into feat-docs-g2
Sep 26, 2023
baf9d93
Fix some compilation errors
Sep 26, 2023
679ec18
Comment out stuff that prevents preview to be built
Sep 26, 2023
8875e00
Environment variables
Sep 26, 2023
77a9937
Merge branch 'main' of https://github.com/appwrite/website into feat-…
TorstenDittmann Sep 26, 2023
1a97a33
chore: remove unused export
TorstenDittmann Sep 26, 2023
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
25 changes: 25 additions & 0 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions src/markdoc/nodes/Link.svelte
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
<script lang="ts">
import { getContext, hasContext } from 'svelte';

export let href: string;
export let title: string;

Expand All @@ -11,7 +9,7 @@

<a class="aw-link" {href} {title} {target} {rel}>
<slot />
{#if isExternal}
<!-- <span class="icon-cheveron-right" /> -->
{#if !isExternal}
<!-- <span class="icon-cheveron-right" /> -->
{/if}
</a>
19 changes: 4 additions & 15 deletions src/partials/account-vs-user.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,10 @@

{% info title="Account vs Users API" %}
Appwrite provides two APIs to manager user accounts.

The Account API is the API you should use in your **client applications** like web, Flutter, mobile, and native apps.
The Account API is the API you should use in your **client applications** with [Client SDKs](/docs/sdks#client) like web, Flutter, mobile, and native apps.
Account API creates sessions, which represent an authenticated user and is attached to a user's [account](/docs/products/auth/accounts).
Sessions respect [permissions](/docs/advanced/platform/permissions), which means users can only access resources if they have been granted the correct permissions.

You'll notice that the Account API doesn't allow you to view or make changes to other users.
This is by design and for **security reasons**.

[Account API references](/docs/references/cloud/client-web/account)
Sessions respect [permissions](/docs/advanced/platform/permissions), which means users can only access resources if they have been granted the correct permissions.

The Users API is a dedicated API for managing users from an admin's perspective. **Do not use the Users API on client applications**.
It should be used with backend or server-side applications with the [Server SDK](#).

Users API uses API keys instead of sessions.
The Users API is a dedicated API for managing users from an admin's perspective.
It should be used with backend or server-side applications with [Server SDKs](/docs/sdks#server). Users API uses API keys instead of sessions.
This means they're not resticted by permissions, but by the scopes granted to the API key used.

[Users API references](/docs/references/cloud/server-nodejs/users)
{% /info %}
39 changes: 19 additions & 20 deletions src/routes/docs/+page.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,16 @@
Run on any provider or through Appwrite Cloud
</h1>
<p class="aw-description u-max-width-600">
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin in ultrices lacus.
Start building today by creating an account on <a href="https://cloud.appwrite.io/" rel="noopener noreferrer" target="_blank">Appwrite Cloud</a>
or <a href="/docs/advanced/self-hosting" rel="noopener noreferrer" target="_blank">self-host</a>.
</p>
</section>
<section class="aw-hero is-align-start">
<h2 class="aw-title aw-u-color-text-primary u-max-width-600">
Get started quickly with your preferred technology
Get started with your technologies
</h2>
<p class="aw-description u-max-width-600">
Start building with your preferred web, mobile, and native frameworks by following a quick
start guide.
Follow a quick start guide on your web, mobile, and native frameworks.
</p>
<ul class="u-flex u-gap-16 aw-u-margin-block-32-mobile aw-u-margin-block-40-not-mobile">
<li>
Expand Down Expand Up @@ -256,8 +256,7 @@
<div>
<h2 class="aw-title aw-u-color-text-primary u-max-width-600">Show me some code</h2>
<p class="aw-description u-max-width-600">
Talk is cheap, where's the code? If you'd rather see some examples, we've got you
covered. Clone a template to get started.
If you learn best from code examples, follow one of our tutorials.
</p>
</div>
</svelte:fragment>
Expand Down Expand Up @@ -401,7 +400,7 @@
</Carousel>
</section>
<section class="aw-hero is-align-start is-no-max-width">
<h2 class="aw-title aw-u-color-text-primary u-max-width-600">Show me some code</h2>
<h2 class="aw-title aw-u-color-text-primary u-max-width-600">Explore capabilities</h2>
<p class="aw-description u-max-width-600">
All the core functionalities you need with a scalable and flexible API. Explore Appwrite's
product offerings.
Expand Down Expand Up @@ -450,7 +449,7 @@
Databases
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Store your application and users' data.
Store your application and user data.
</p>
</div>
</li>
Expand Down Expand Up @@ -522,7 +521,7 @@
Realtime
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Listen to any events on the server-side in realtime.
Respond to server events in realtime.
</p>
</div>
</li>
Expand All @@ -538,7 +537,7 @@
Messaging
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Send email, SMS, push notification and chat messages to your users.
Coming soon.
</p>
</div>
</li>
Expand All @@ -557,7 +556,7 @@
<div class="aw-card is-full-color">
<h4 class="aw-sub-body-500 aw-u-color-text-primary u-margin-block-start-8">SDKs</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur. Elit id et diam lectus egestas habitasse.
Light-weight SDKs for your favorite platforms.
</p>
</div>
</li>
Expand All @@ -567,7 +566,7 @@
REST API
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur. Elit id et diam lectus egestas habitasse.
Integrate with HTTP requests without the needing an SDK
</p>
</div>
</li>
Expand All @@ -577,7 +576,7 @@
GraphQL
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur. Elit id et diam lectus egestas habitasse.
Leverage GraphQL through our SDKs or integrate directly with REST endpoints.
</p>
</div>
</li>
Expand All @@ -587,7 +586,7 @@
Realtime
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur. Elit id et diam lectus egestas habitasse.
Respond to auth, databases, storage, and function events in realtime.
</p>
</div>
</li>
Expand All @@ -597,17 +596,17 @@
<section class="aw-hero is-align-start is-no-max-width">
<h2 class="aw-title aw-u-color-text-primary u-max-width-600">Migrate to Appwrite</h2>
<p class="aw-description u-max-width-600">
Lorem ipsum dolor sit amet consectetur. Orci netus est urna dictum eleifend diam.
Own your data with automatic data migrations.
</p>
<div class="u-margin-block-start-24">
<ul class="aw-grid-row-4">
<li>
<div class="aw-card is-full-color">
<h4 class="aw-sub-body-500 aw-u-color-text-primary u-margin-block-start-8">
Self hosted
Self-hosted
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur.
Move data from self-hosted to Appwrite Cloud.
</p>
</div>
</li>
Expand All @@ -617,7 +616,7 @@
Firebase
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur.
Migrate users and data from Firebase to Appwrite.
</p>
</div>
</li>
Expand All @@ -627,15 +626,15 @@
Supabase
</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur.
Migrate users and data from Supabase to Appwrite.
</p>
</div>
</li>
<li>
<div class="aw-card is-full-color">
<h4 class="aw-sub-body-500 aw-u-color-text-primary u-margin-block-start-8">Nhost</h4>
<p class="aw-sub-body-400 u-margin-block-start-4">
Lorem ipsum dolor sit amet consectetur.
Migrate users and data from NHost to Appwrite.
</p>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/Sidebar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
},
{
label: 'Self-hosting',
href: '/docs/advanced/self-hosting/installation',
href: '/docs/advanced/self-hosting',
icon: 'icon-server',
isParent: true
}
Expand Down
11 changes: 7 additions & 4 deletions src/routes/docs/advanced/migrations/firebase/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,18 @@ To begin migrating to Appwrite, follow these steps.

1. Click on the **Create Migration** button and select **Firebase** as your source.

1. Upload the JSON file to Appwrite and follow the migration wizard to select which resources you need to migrate.
1. Upload the JSON file to Appwrite and follow the migration wizard to select which resources you need to migrate. Finally click **Start migration** to begin the migration process.

1. Add the platforms for your [Web](#), [Flutter](#), [Android](#), and [iOS](#) apps. Appwrite will reject requests from unknown web, Flutter, and mobile apps to protect from malicious attacks. You app **must be added as a platform** for Appwrite to accept requests.
{% /section %}
{% section #next-steps step=4 title="Next steps" %}

1. In your Appwrite Console, navigate to **Overview** > **Integrations** > **Platforms**, add the platforms for your Web, Flutter, Android, and iOS apps. Appwrite will reject requests from unknown web, Flutter, and mobile apps to protect from malicious attacks. You app **must be added as a platform** for Appwrite to accept requests.

1. Remember to [add appropriate permissions](/docs/advanced/platform/permissions) to the migrated resources to protect user data and privacy.

1. Migrate functions manually, by [pick a runtime](#) and [learn to develop Appwrite Functions](#).
1. Migrate functions manually, by [pick a runtime](/docs/products/functions/runtimes) and [learn to develop Appwrite Functions](/docs/products/functions/development).

1. Explore Appwrite's unique feature by exploring the [TODO]
1. Explore Appwrite's unique features by exploring the rest of the [Appwrite Documentation](/docs).

{% /section %}

Expand Down
6 changes: 3 additions & 3 deletions src/routes/docs/advanced/migrations/nhost/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ Before migrating to Appwrite make sure you've read the [migration overview](/doc

{% section #next-steps step=3 title="Next steps" %}

1. Add the platforms for your [Web](#), [Flutter](#), [Android](#), and [iOS](#) apps. Appwrite will reject requests from unknown web, Flutter, and mobile apps to protect from malicious attacks. You app **must be added as a platform** for Appwrite to accept requests.
1. In your Appwrite Console, navigate to **Overview** > **Integrations** > **Platforms**, add the platforms for your Web, Flutter, Android, and iOS apps. Appwrite will reject requests from unknown web, Flutter, and mobile apps to protect from malicious attacks. You app **must be added as a platform** for Appwrite to accept requests.

1. Remember to [add appropriate permissions](/docs/advanced/platform/permissions) to the migrated resources to protect user data and privacy.

1. Migrate functions manually, by [pick a runtime](#) and [learn to develop Appwrite Functions](#).
1. Migrate functions manually, by [pick a runtime](/docs/products/functions/runtimes) and [learn to develop Appwrite Functions](/docs/products/functions/development).

1. Explore Appwrite's unique feature by exploring the [TODO]
1. Explore Appwrite's unique features by exploring the rest of the [Appwrite Documentation](/docs).

{% /section %}

Expand Down
5 changes: 3 additions & 2 deletions src/routes/docs/advanced/migrations/self-hosted/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ To begin migrating to self-hosted, make sure to read the [migration overview](/d

1. Click **Start Migration** to start the migration process. You do not need to keep the Appwrite Console open through the process.

> Keep in mind: Your self-hosted instance will generate an API Key in the background to pass to Appwrite Cloud. You can revoke this key after the migration process is complete.

{% info title="Keep in mind" %}
Your self-hosted instance will generate an API Key in the background to pass to Appwrite Cloud. You can revoke this key after the migration process is complete.
{% /info %}
{% /section %}
6 changes: 3 additions & 3 deletions src/routes/docs/advanced/migrations/supabase/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ Before migrating to Appwrite make sure you've read the [migration overview](/doc

{% section #next-steps step=3 title="Next steps" %}

1. Add the platforms for your [Web](#), [Flutter](#), [Android](#), and [iOS](#) apps. Appwrite will reject requests from unknown web, Flutter, and mobile apps to protect from malicious attacks. You app **must be added as a platform** for Appwrite to accept requests.
1. In your Appwrite Console, navigate to **Overview** > **Integrations** > **Platforms**, add the platforms for your Web, Flutter, Android, and iOS apps. Appwrite will reject requests from unknown web, Flutter, and mobile apps to protect from malicious attacks. You app **must be added as a platform** for Appwrite to accept requests.

1. Remember to [add appropriate permissions](/docs/advanced/platform/permissions) to the migrated resources to protect user data and privacy.

1. Migrate functions manually, by [pick a runtime](#) and [learn to develop Appwrite Functions](#).
1. Migrate functions manually, by [pick a runtime](/docs/products/functions/runtimes) and [learn to develop Appwrite Functions](/docs/products/functions/development).

1. Explore Appwrite's unique feature by exploring the [TODO]
1. Explore Appwrite's unique features by exploring the rest of the [Appwrite Documentation](/docs).

{% /section %}

Expand Down
44 changes: 29 additions & 15 deletions src/routes/docs/advanced/platform/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,25 @@
]
},
{
label: 'Guides',
label: 'Integration',
items: [
{
label: 'API keys',
href: '/docs/advanced/platform/api-keys'
},
{
label: 'Custom domains',
href: '/docs/advanced/platform/custom-domains'
},
{
label: 'Events',
href: '/docs/advanced/platform/events'
},
{
label: 'Response codes',
href: '/docs/advanced/platform/response-codes'
label: 'Webhooks',
href: '/docs/advanced/platform/webhooks'
},
{
label: 'Response codes',
href: '/docs/advanced/platform/response-codes',
}
]
},
{
label: 'Access control',
items: [
{
label: 'Permissions',
href: '/docs/advanced/platform/permissions'
Expand All @@ -45,11 +46,24 @@
href: '/docs/advanced/platform/rate-limits'
},
{
label: 'Webhooks',
href: '/docs/advanced/platform/webhooks'
}
label: 'API keys',
href: '/docs/advanced/platform/api-keys'
},
]
}
},
{
label: 'Configuration',
items: [
{
label: 'Custom domains',
href: '/docs/advanced/platform/custom-domains'
},
{
label: 'Email and SMS templates',
href: '/docs/advanced/platform/message-templates'
},
]
},
];
</script>

Expand Down
23 changes: 0 additions & 23 deletions src/routes/docs/advanced/platform/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,3 @@ description: Description for SEO.
Appwrite is a development platform designed to adapt your unique use cases.
Appwrite provides features that help you maintain, scale, and integrate Appwrite with other platforms.

## API keys {% #api-keys %}

[Learn more about API keys {% icon icon="cheveron-right" /%}](#)

## Custom domains {% #custom-domains %}

[Learn more about custom domains {% icon icon="cheveron-right" /%}](#)

## Events {% #events %}

[Learn more about events {% icon icon="cheveron-right" /%}](#)

## Response codes {% #response-codes %}

[Learn more about response codes {% icon icon="cheveron-right" /%}](#)

## Permissions {% #permissions %}

[Learn more about permissions {% icon icon="cheveron-right" /%}](#)

## Rate limits {% #rate-limits %}

[Learn more about permissions {% icon icon="cheveron-right" /%}](#)
Loading