Add wizard for web platform

This commit is contained in:
ernstmul committed 2025-02-18 15:26:05 +01:00
1 parent 43a1e36087
commit 23dbc1af01
13 files changed
+406 -11

No files matched your search

+1 -1
View File
@@ -23,7 +23,7 @@
"@appwrite.io/pink-icons": "0.25.0",
"@appwrite.io/pink-icons-svelte": "https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@35f29290",
"@appwrite.io/pink-legacy": "^1.0.1",
"@appwrite.io/pink-svelte": "https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@35f29290",
"@appwrite.io/pink-svelte": "https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@502e72a",
"@popperjs/core": "^2.11.8",
"@sentry/sveltekit": "^8.38.0",
"@stripe/stripe-js": "^3.5.0",
+9 -9
View File
@@ -21,8 +21,8 @@ importers:
specifier: ^1.0.1
version: 1.0.1
'@appwrite.io/pink-svelte':
specifier: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@35f29290
version: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@35f29290(react-dom@18.3.1(react@18.3.1))(svelte@4.2.19)
specifier: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@502e72a
version: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@502e72a(react-dom@18.3.1(react@18.3.1))(svelte@4.2.19)
'@popperjs/core':
specifier: ^2.11.8
version: 2.11.8
@@ -221,8 +221,8 @@ packages:
peerDependencies:
svelte: ^4.0.0
'@appwrite.io/pink-icons-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@35f2929064b9d126a377b6a3e85f59198c5901a2':
resolution: {tarball: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@35f2929064b9d126a377b6a3e85f59198c5901a2}
'@appwrite.io/pink-icons-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@502e72a565c4b404703cd1288f94d40273dbb639':
resolution: {tarball: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@502e72a565c4b404703cd1288f94d40273dbb639}
version: 1.0.0-next.7
peerDependencies:
svelte: ^4.0.0
@@ -236,8 +236,8 @@ packages:
'@appwrite.io/pink-legacy@1.0.1':
resolution: {integrity: sha512-e5IZx2drqSxgl2WXvmr0eLfg/WiOCzuqQE8oksD+9GoFBkcL9HWvXul5GjFni3RBAN9XFRL3nUExGk4T0H8sFw==}
'@appwrite.io/pink-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@35f29290':
resolution: {tarball: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@35f29290}
'@appwrite.io/pink-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@502e72a':
resolution: {tarball: https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@502e72a}
version: 1.0.0-next.85
peerDependencies:
react-dom: ^18.0.0
@@ -4103,7 +4103,7 @@ snapshots:
dependencies:
svelte: 4.2.19
'@appwrite.io/pink-icons-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@35f2929064b9d126a377b6a3e85f59198c5901a2(svelte@4.2.19)':
'@appwrite.io/pink-icons-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@502e72a565c4b404703cd1288f94d40273dbb639(svelte@4.2.19)':
dependencies:
svelte: 4.2.19
@@ -4116,9 +4116,9 @@ snapshots:
'@appwrite.io/pink-icons': 1.0.0
the-new-css-reset: 1.11.3
'@appwrite.io/pink-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@35f29290(react-dom@18.3.1(react@18.3.1))(svelte@4.2.19)':
'@appwrite.io/pink-svelte@https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-svelte@502e72a(react-dom@18.3.1(react@18.3.1))(svelte@4.2.19)':
dependencies:
'@appwrite.io/pink-icons-svelte': https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@35f2929064b9d126a377b6a3e85f59198c5901a2(svelte@4.2.19)
'@appwrite.io/pink-icons-svelte': https://pkg.pr.new/appwrite/pink/@appwrite.io/pink-icons-svelte@502e72a565c4b404703cd1288f94d40273dbb639(svelte@4.2.19)
'@floating-ui/dom': 1.6.13
'@melt-ui/pp': 0.3.2(@melt-ui/svelte@0.86.3(svelte@4.2.19))(svelte@4.2.19)
'@melt-ui/svelte': 0.86.3(svelte@4.2.19)
@@ -47,6 +47,7 @@
export let pingCount = 0;
function openPlatformWizard(type: number, platform?: Models.Platform) {
console.log(platform);
if (platform) {
continuePlatform(type, platform.name, platform.key, platform.type);
} else {
@@ -6,6 +6,7 @@
import CreateApple from './createApple.svelte';
import CreateFlutter from './createFlutter.svelte';
import CreateReactNative from './createReactNative.svelte';
import CreateWeb from './createWeb.svelte';
import { createPlatform, versions } from './wizard/store';
export enum Platform {
@@ -36,11 +37,13 @@
});
wizard.start(platforms[platform], null, 1, {
isPlatformCreated: true,
platform: type
platform: type,
key: key
});
}
const platforms = {
[Platform.Web]: CreateWeb,
[Platform.Flutter]: CreateFlutter,
[Platform.Android]: CreateAndroid,
[Platform.Apple]: CreateApple,
@@ -0,0 +1,5 @@
<script>
import { SvgIcon } from '$lib/components';
</script>
<SvgIcon name="nextjs" type="color" iconSize="" />
@@ -0,0 +1,11 @@
<script lang="ts">
import noFrameworkIcon from './noFrameworkIcon.svg';
import noFrameworkIconDark from './noFrameworkIconDark.svg';
import { app } from '$lib/stores/app';
</script>
{#if $app.themeInUse === 'light'}
<img src={noFrameworkIcon} alt="" />
{:else}
<img src={noFrameworkIconDark} alt="" />
{/if}
@@ -0,0 +1,5 @@
<script>
import { SvgIcon } from '$lib/components';
</script>
<SvgIcon name="nuxt" type="color" iconSize="" />
@@ -0,0 +1,5 @@
<script>
import { SvgIcon } from '$lib/components';
</script>
<SvgIcon name="react" type="color" iconSize="" />
@@ -0,0 +1,5 @@
<script>
import { SvgIcon } from '$lib/components';
</script>
<SvgIcon name="svelte" type="color" iconSize="" />
@@ -0,0 +1,5 @@
<script>
import { SvgIcon } from '$lib/components';
</script>
<SvgIcon name="vue" type="color" iconSize="" />
@@ -0,0 +1,8 @@
<svg width="79" height="79" viewBox="0 0 79 79" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M22.5 0L22 79" stroke="#EDEDF0" stroke-dasharray="2 2"/>
<path d="M79 23L-2.38419e-06 23" stroke="#EDEDF0" stroke-dasharray="2 2"/>
<path d="M79 56.5L-2.38419e-06 56.5" stroke="#EDEDF0" stroke-dasharray="2 2"/>
<path d="M56.5 0V79" stroke="#EDEDF0" stroke-dasharray="2 2"/>
<circle cx="39.5" cy="39.5" r="17" stroke="#EDEDF0" stroke-dasharray="2 2"/>
<circle cx="39.5" cy="39.5" r="25" stroke="#EDEDF0" stroke-dasharray="2 2"/>
</svg>

After

Width:  |  Height:  |  Size: 564 B

@@ -0,0 +1,8 @@
<svg width="79" height="79" viewBox="0 0 79 79" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M22.5 0L22 79" stroke="#2D2D31" stroke-dasharray="2 2"/>
<path d="M79 23L-2.38419e-06 23" stroke="#2D2D31" stroke-dasharray="2 2"/>
<path d="M79 56.5L-2.38419e-06 56.5" stroke="#2D2D31" stroke-dasharray="2 2"/>
<path d="M56.5 0V79" stroke="#2D2D31" stroke-dasharray="2 2"/>
<circle cx="39.5" cy="39.5" r="17" stroke="#2D2D31" stroke-dasharray="2 2"/>
<circle cx="39.5" cy="39.5" r="25" stroke="#2D2D31" stroke-dasharray="2 2"/>
</svg>

After

Width:  |  Height:  |  Size: 564 B

@@ -0,0 +1,339 @@
<script lang="ts">
import { Wizard } from '$lib/layout';
import { invalidate } from '$app/navigation';
import { createPlatform } from './wizard/store';
import { Dependencies } from '$lib/constants';
import {
Code,
Layout,
Icon,
Typography,
Fieldset,
InlineCode,
Card,
Button as ButtonV2
} from '@appwrite.io/pink-svelte';
import { Button, Form } from '$lib/elements/forms';
import {
IconVue,
IconAppwrite,
IconSvelte,
IconReact,
IconNuxt
} from '@appwrite.io/pink-icons-svelte';
import { page } from '$app/stores';
import { type ComponentType, onMount } from 'svelte';
import { sdk } from '$lib/stores/sdk';
import { Submit, trackError, trackEvent } from '$lib/actions/analytics';
import { addNotification } from '$lib/stores/notifications';
import { fade } from 'svelte/transition';
import ConnectionLine from './components/ConnectionLine.svelte';
import OnboardingPlatformCard from './components/OnboardingPlatformCard.svelte';
import { PlatformType } from '@appwrite.io/console';
import ReactFrameworkIcon from './components/ReactFrameworkIcon.svelte';
import SvelteFrameworkIcon from '$routes/(console)/project-[project]/overview/platforms/components/SvelteFrameworkIcon.svelte';
import NuxtFrameworkIcon from '$routes/(console)/project-[project]/overview/platforms/components/NuxtFrameworkIcon.svelte';
import NextjsFrameworkIcon from '$routes/(console)/project-[project]/overview/platforms/components/NextjsFrameworkIcon.svelte';
import VueFrameworkIcon from '$routes/(console)/project-[project]/overview/platforms/components/VueFrameworkIcon.svelte';
import NoFrameworkIcon from './components/NoFrameworkIcon.svelte';
export let key;
let showExitModal = false;
let isPlatformCreated = !!key;
let isCreatingPlatform = false;
let connectionSuccessful = false;
let isChangingFramework = false;
const projectId = $page.params.project;
const updateConfigCode = `APPWRITE_PROJECT_ID = "${projectId}"
APPWRITE_PUBLIC_ENDPOINT = "${sdk.forProject.client.config.endpoint}"
`;
type FrameworkType = {
key: string;
label: string;
icon: ComponentType;
smallIcon: ComponentType;
gitCloneCode: string;
};
export let platform: PlatformType = PlatformType.Flutterandroid;
export let selectedFrameworkKey: string | undefined = key ? key : undefined;
let frameworks: Array<FrameworkType> = [
{
key: 'svelte',
label: 'Svelte',
icon: SvelteFrameworkIcon,
smallIcon: IconSvelte,
gitCloneCode:
'\ngit clone https://github.com/appwrite/starter-for-svelte\ncd starter-for-svelte'
},
{
key: 'react',
label: 'React',
icon: ReactFrameworkIcon,
smallIcon: IconReact,
gitCloneCode:
'\ngit clone https://github.com/appwrite/starter-for-react\ncd starter-for-react'
},
{
key: 'nuxt',
label: 'Nuxt',
icon: NuxtFrameworkIcon,
smallIcon: IconNuxt,
gitCloneCode:
'\ngit clone https://github.com/appwrite/starter-for-nuxt\ncd starter-for-nuxt'
},
{
key: 'nextjs',
label: 'Next.js',
icon: NextjsFrameworkIcon,
smallIcon: NextjsFrameworkIcon,
gitCloneCode:
'\ngit clone https://github.com/appwrite/starter-for-nextjs\ncd starter-for-nextjs'
},
{
key: 'vue',
label: 'Vue',
icon: VueFrameworkIcon,
smallIcon: IconVue,
gitCloneCode:
'\ngit clone https://github.com/appwrite/starter-for-vue\ncd starter-for-vue'
}
];
$: selectedFramework = frameworks.find((framework) => framework.key === selectedFrameworkKey);
$: selectedFrameworkIcon = selectedFramework ? selectedFramework.icon : NoFrameworkIcon;
async function createWebPlatform() {
try {
isCreatingPlatform = true;
await sdk.forConsole.projects.createPlatform(
projectId,
PlatformType.Web,
`${selectedFramework.label} app`,
selectedFrameworkKey,
undefined,
undefined
);
isPlatformCreated = true;
trackEvent(Submit.PlatformCreate, {
type: platform
});
await Promise.all([
invalidate(Dependencies.PROJECT),
invalidate(Dependencies.PLATFORMS)
]);
} catch (error) {
trackError(error, Submit.PlatformCreate);
addNotification({
type: 'error',
message: error.message
});
} finally {
isCreatingPlatform = false;
}
}
async function resetPlatformStore() {
createPlatform.reset();
}
onMount(() => {
const unsubscribe = sdk.forConsole.client.subscribe('console', (response) => {
if (response.events.includes(`projects.${projectId}.ping`)) {
connectionSuccessful = true;
invalidate(Dependencies.ORGANIZATION);
invalidate(Dependencies.PROJECT);
unsubscribe();
}
});
return () => {
unsubscribe();
resetPlatformStore();
};
});
</script>
<Wizard title="Add web platform" bind:showExitModal confirmExit>
<Form onSubmit={createWebPlatform}>
<Layout.Stack gap="xxl">
<!-- Step One -->
{#if !isPlatformCreated || isChangingFramework}
<Fieldset legend="Type">
<Layout.Stack>
<div class="frameworks">
{#each frameworks as framework}
<Card.Selector
bind:group={selectedFrameworkKey}
name="framework"
id={framework.key}
value={framework.key}
title={framework.label}
icon={framework.icon}
imageRadius="s" />
{/each}
</div>
<Layout.Stack direction="row" justifyContent="flex-end">
{#if isChangingFramework}
<Button
fullWidthMobile
size="s"
forceShowLoader
submissionLoader={isCreatingPlatform}
disabled={!selectedFramework}
on:click={() => {
isChangingFramework = false;
}}>
Change framework instructions
</Button>
{:else}
<Button
fullWidthMobile
size="s"
submit
forceShowLoader
submissionLoader={isCreatingPlatform}
disabled={!selectedFramework}>
Create platform
</Button>
{/if}
</Layout.Stack>
</Layout.Stack>
</Fieldset>
{:else}
<Card.Base padding="s"
><Layout.Stack
direction="row"
justifyContent="space-between"
alignItems="center">
<Layout.Stack gap="xxs" direction="row">
<Icon icon={selectedFramework.smallIcon} />
<Typography.Text variant="m-500"
>{selectedFramework.label}</Typography.Text>
</Layout.Stack>
<ButtonV2.Button
variant="secondary"
size="s"
on:click={() => {
isChangingFramework = true;
}}>Change</ButtonV2.Button>
</Layout.Stack></Card.Base>
{/if}
<!-- Step Three -->
{#if isPlatformCreated && !isChangingFramework}
<Fieldset legend="Clone starter">
<Layout.Stack gap="l">
<Typography.Text variant="m-500">
1. Clone the starter kit from GitHub using the terminal or VSCode.
</Typography.Text>
<!-- Temporary fix: Remove this div once Code splitting issue with stack spacing is resolved -->
<div class="pink2-code-margin-fix">
<Code lang="bash" lineNumbers code={selectedFramework.gitCloneCode} />
</div>
<Typography.Text variant="m-500"
>2. Rename <InlineCode size="s" code=".env.example" /> into <InlineCode
size="s"
code=".env" /> and update the values.</Typography.Text>
<!-- Temporary fix: Remove this div once Code splitting issue with stack spacing is resolved -->
<div class="pink2-code-margin-fix">
<Code lang="bash" lineNumbers code={updateConfigCode} />
</div>
<Typography.Text variant="m-500"
>3. Install project dependencies</Typography.Text>
<!-- Temporary fix: Remove this div once Code splitting issue with stack spacing is resolved -->
<div class="pink2-code-margin-fix">
<Code lang="bash" lineNumbers code={'npm install'} />
</div>
<Typography.Text variant="m-500"
>3. Run the app, then click the <InlineCode
size="s"
code="Send a ping" /> button to verify the setup.</Typography.Text>
</Layout.Stack>
</Fieldset>
{/if}
</Layout.Stack>
</Form>
<svelte:fragment slot="aside">
<Card.Base>
<Layout.Stack gap="xxl">
<Layout.Stack direction="row" justifyContent="center" gap="none">
<OnboardingPlatformCard iconSize={2.526} icon={selectedFrameworkIcon} />
<ConnectionLine status={connectionSuccessful} />
<OnboardingPlatformCard
iconSize={2.526}
iconColor="#FD366E"
icon={IconAppwrite} />
</Layout.Stack>
{#if isPlatformCreated}
<Layout.Stack
direction="row"
justifyContent="center"
alignItems="center"
gap="l">
{#if !connectionSuccessful}
<Typography.Text variant="m-400"
>Waiting for connection...</Typography.Text>
{:else}
<!-- cannot apply fade on components -->
<div
in:fade={{ duration: 2500 }}
class="u-flex u-flex-vertical u-cross-center u-gap-8">
<Typography.Title size="m">Congratulations!</Typography.Title>
<Typography.Text variant="m-400"
>You connected your app successfully.</Typography.Text>
</div>
{/if}
</Layout.Stack>
{/if}
</Layout.Stack>
</Card.Base>
</svelte:fragment>
<svelte:fragment slot="footer">
{#if isPlatformCreated}
<Button
size="s"
fullWidthMobile
secondary
disabled={isCreatingPlatform}
href={location.pathname}>
Go to dashboard
</Button>
{/if}
</svelte:fragment>
</Wizard>
<style lang="scss">
:global(.pink2-code-margin-fix pre) {
margin: revert;
}
:global(.responsive-padding) {
@media (max-width: 768px) {
padding: 16px;
}
}
.frameworks {
display: grid;
grid-template-columns: repeat(3, 1fr);
gap: var(--gap-l, 16px);
}
</style>