Merge pull request #2199 from appwrite/fix-flutter-onboarding-guide

This commit is contained in:
Darshan authored and GitHub committed 2025-08-11 09:17:03 +05:30
commit 3d7adf3956
2 files changed
+28 -10

No files matched your search

@@ -26,6 +26,7 @@
import OnboardingPlatformCard from './components/OnboardingPlatformCard.svelte';
import { PlatformType } from '@appwrite.io/console';
import { isCloud } from '$lib/system';
import { project } from '../../store';
let showExitModal = false;
let isPlatformCreated = false;
@@ -36,11 +37,15 @@
const gitCloneCode =
'\ngit clone https://github.com/appwrite/starter-for-flutter\ncd starter-for-flutter\n';
const baseConfig = `class Environment {
static const String appwriteProjectId = '${projectId}';
static const String appwriteProjectName = '${$project.name}';`;
const updateConfigCode = isCloud
? `static const String APPWRITE_PROJECT_ID = "${projectId}"`
: `static const String APPWRITE_PROJECT_ID = "${projectId}"
static const String APPWRITE_PUBLIC_ENDPOINT = "${sdk.forProject(page.params.region, page.params.project).client.config.endpoint}"
`;
? `${baseConfig}\n}`
: `${baseConfig}
static const String appwriteEndpoint = '${sdk.forProject(page.params.region, page.params.project).client.config.endpoint}';
}`;
export let platform: PlatformType = PlatformType.Flutterandroid;
@@ -276,8 +281,8 @@ static const String APPWRITE_PUBLIC_ENDPOINT = "${sdk.forProject(page.params.reg
</div>
<Typography.Text variant="m-500"
>2. Open the file <InlineCode size="s" code="lib/constants/appwrite.dart" />
and update the configuration settings.</Typography.Text>
>2. Replace <InlineCode size="s" code="lib/config/environment.dart" />
to reflect the values below:</Typography.Text>
<!-- Temporary fix: Remove this div once Code splitting issue with stack spacing is resolved -->
<div class="pink2-code-margin-fix">
@@ -285,7 +290,9 @@ static const String APPWRITE_PUBLIC_ENDPOINT = "${sdk.forProject(page.params.reg
</div>
<Typography.Text variant="m-500"
>3. Run the app on a connected device or simulator, then click the <InlineCode
>3. Run the app on a connected device or simulator using <InlineCode
size="s"
code="flutter run -d [device_name]" />, then click the <InlineCode
size="s"
code="Send a ping" /> button to verify the setup.</Typography.Text>
</Layout.Stack>
@@ -128,7 +128,15 @@ ${prefix}APPWRITE_ENDPOINT = "${sdk.forProject(page.params.region, page.params.p
smallIcon: IconAngular,
portNumber: 4200,
runCommand: 'npm run start',
updateConfigCode: `appwriteEndpoint: '${sdk.forProject(page.params.region, page.params.project).client.config.endpoint}',\nappwriteProjectId: '${projectId}',\nappwriteProjectName: '${$project.name}'`
updateConfigCode: `export const environment: {
appwriteEndpoint: string;
appwriteProjectId: string;
appwriteProjectName: string;
} = {
appwriteEndpoint: '${sdk.forProject(page.params.region, page.params.project).client.config.endpoint}',
appwriteProjectId: '${projectId}',
appwriteProjectName: '${$project.name}'
};`
},
{
key: 'js',
@@ -290,7 +298,7 @@ ${prefix}APPWRITE_ENDPOINT = "${sdk.forProject(page.params.region, page.params.p
{#if selectedFramework.key === 'angular'}
<Typography.Text variant="m-500"
>2. Change <InlineCode
>2. Replace <InlineCode
size="s"
code="src/environments/environment.ts" />
to reflect the values below:</Typography.Text>
@@ -303,7 +311,10 @@ ${prefix}APPWRITE_ENDPOINT = "${sdk.forProject(page.params.region, page.params.p
<!-- Temporary fix: Remove this div once Code splitting issue with stack spacing is resolved -->
<div class="pink2-code-margin-fix">
<Code lang="dotenv" lineNumbers code={selectedFramework.updateConfigCode} />
<Code
lang={selectedFramework.key === 'angular' ? 'ts' : 'dotenv'}
lineNumbers
code={selectedFramework.updateConfigCode} />
</div>
<Typography.Text variant="m-500"