Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit 8de9717

Browse files
authored
Merge pull request #212 from appwrite/fix-web-sdk-docs
Fix getting started guide for web
2 parents 47d8102 + f30d01b commit 8de9717

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

app/views/docs/getting-started-for-web.phtml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ $demos = $platform['demos'] ?? [];
4646
<p>When you're using a bundler (like <a href="http://browserify.org/" target="_blank" rel="noopener">Browserify</a> or <a href="https://webpack.js.org/" target="_blank" rel="noopener">Webpack</a>), import the Appwrite module when you need it:</p>
4747

4848
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
49-
<pre class="line-numbers"><code class="prism language-javascript" data-prism>import { Appwrite } from 'appwrite';</code></pre>
49+
<pre class="line-numbers"><code class="prism language-javascript" data-prism>import { Client, Account } from 'appwrite';</code></pre>
5050
</div>
5151

5252
<h3><a href="/docs/getting-started-for-web#cdn" id="cdn">CDN</a></h3>
@@ -62,15 +62,13 @@ $demos = $platform['demos'] ?? [];
6262
<p>Initialize your SDK code with your project ID which can be found in your project settings page.</p>
6363

6464
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
65-
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Init your Web SDK
66-
const appwrite = new Appwrite();
65+
<pre class="line-numbers"><code class="prism language-javascript" data-prism>const client = new Client();
6766

68-
appwrite
69-
.setEndpoint('http://localhost/v1') // Your Appwrite Endpoint
70-
.setProject('455x34dfkj') // Your project ID
71-
;
72-
73-
</code></pre>
67+
// Init your Web SDK
68+
client
69+
.setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
70+
.setProject('5df5acd0d48c2') // Your project ID
71+
;</code></pre>
7472
</div>
7573
<!--
7674
<div class="notice calm margin-top-large margin-bottom-large">
@@ -84,15 +82,15 @@ appwrite
8482
<p>After your SDK configuration is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would use is found in the SDK documentation or in the API References section.</p>
8583

8684
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
87-
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Register User
88-
appwrite
89-
.account.create('unique()', '[email protected]', 'password', 'Jane Doe')
85+
<pre class="line-numbers"><code class="prism language-javascript" data-prism>const account = new Account(client);
86+
87+
// Register User
88+
account.create('unique()', '[email protected]', 'password', 'Jane Doe')
9089
.then(response => {
9190
console.log(response);
9291
}, error => {
9392
console.log(error);
94-
});
95-
</code></pre>
93+
});</code></pre>
9694
</div>
9795

9896
<h2><a href="/docs/getting-started-for-web#listenToChanges" id="listenToChanges">Listen to Changes</a></h2>
@@ -101,41 +99,43 @@ appwrite
10199

102100
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
103101
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Subscribe to files channel
104-
appwrite.subscribe('files', response => {
102+
client.subscribe('files', response => {
105103
if(response.events.includes('buckets.*.files.*.create')) {
106104
// Log when a new file is uploaded
107105
console.log(response.payload);
108106
}
109-
});
110-
</code></pre>
107+
});</code></pre>
111108
</div>
112109

113110
<h2><a href="/docs/getting-started-for-web#fullExample" id="fullExample">Full Example</a></h2>
114111
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
115-
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Init your Web SDK
116-
const appwrite = new Appwrite();
112+
<pre class="line-numbers"><code class="prism language-javascript" data-prism>import { Client, Account } from "appwrite";
113+
114+
const client = new Client();
115+
116+
// Init your Web SDK
117+
client
118+
.setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
119+
.setProject('5df5acd0d48c2') // Your project ID
120+
;
117121

118-
appwrite
119-
.setEndpoint('http://localhost/v1') // Your Appwrite Endpoint
120-
.setProject('455x34dfkj') // Your project ID
122+
const account = new Account(client);
121123

122124
// Register User
123-
appwrite
124-
.account.create('unique()', '[email protected]', 'password', 'Jane Doe')
125+
account.create('unique()', '[email protected]', 'password', 'Jane Doe')
125126
.then(response => {
126127
console.log(response);
127128
}, error => {
128129
console.log(error);
129130
});
130131

131132
// Subscribe to files channel
132-
appwrite.subscribe('files', response => {
133+
client.subscribe('files', response => {
133134
if(response.events.includes('buckets.*.files.*.create')) {
134135
// Log when a new file is uploaded
135136
console.log(response.payload);
136137
}
137-
});
138-
</code></pre>
138+
});</code></pre>
139139
</div>
140140

141141
<h2><a href="/docs/getting-started-for-web#demos" id="demos">Demos</a></h2>

0 commit comments

Comments
 (0)