Skip to content
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

Update GETTING_STARTED.md #6826

Merged
Show file tree
Hide file tree
Changes from 50 commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
93fa749
Update GETTING_STARTED.md
GuptaPratik02 Oct 6, 2023
9ccaa5a
Update GETTING_STARTED.md
GuptaPratik02 Oct 11, 2023
eaba2eb
Merge branch 'main' into doc-sdks-python-update-getting-started-guide
Oct 12, 2023
8cc1c0d
Update android GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
4be8be1
Update apple GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
777c8dd
Update dart GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
b334f2e
Update deno GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
0587aec
Update dotnet GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
613a733
Update dart EXAMPLES.md
GuptaPratik02 Oct 16, 2023
2c3b860
Update flutter-dev EXAMPLES.md
GuptaPratik02 Oct 16, 2023
006d423
Update flutter GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
0d314df
Update flutter EXAMPLES.md
GuptaPratik02 Oct 16, 2023
7d2b450
Update kotlin GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
e93681a
Update nodejs GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
086116d
Update php GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
acc408f
Update ruby GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
303212f
Update swift GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
bb9dd44
Update web GETTING_STARTED.md
GuptaPratik02 Oct 16, 2023
4b7c13d
changes made android GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
af87c24
changes made apple GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
7721f29
changes made dart GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
2d123f6
changes made dart EXAMPLES.md
GuptaPratik02 Oct 17, 2023
ec17284
changes made deno GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
8ac7aca
changes made dotnet GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
e920c1f
changes made flutter-dev EXAMPLES.md
GuptaPratik02 Oct 17, 2023
ba8cafb
changes made flutter GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
e6b0d22
changes made flutter EXAMPLES.md
GuptaPratik02 Oct 17, 2023
2cce144
changes made nodejs GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
d37bfa0
changes made php GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
5138d4c
changes made ruby GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
569d54b
changes made swift GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
8d7ab13
changes made web GETTING_STARTED.md
GuptaPratik02 Oct 17, 2023
a66fc13
Update android GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
8fed930
Update apple GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
ea282a1
Update dart GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
6c4983f
Update dart EXAMPLES.md
GuptaPratik02 Oct 18, 2023
618c145
Update deno GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
15863c2
Update dotnet GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
0c2374e
Update flutter-dev EXAMPLES.md
GuptaPratik02 Oct 18, 2023
154e972
Update flutter GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
f628115
Update flutter EXAMPLES.md
GuptaPratik02 Oct 18, 2023
902f20f
Update kotlin GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
88efb36
Update nodejs GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
a5ea32c
Update php GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
d3b91b5
Update python GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
a26c921
Update ruby GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
b2e4513
Update swift GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
0853de0
Update web GETTING_STARTED.md
GuptaPratik02 Oct 18, 2023
7d23b0a
Update dotnet GETTING_STARTED.md
GuptaPratik02 Oct 19, 2023
c2c6451
Update nodejs GETTING_STARTED.md
GuptaPratik02 Oct 19, 2023
da504ba
Rectified android GETTING_STARTED.md
GuptaPratik02 Oct 24, 2023
9eea574
Rectified apple GETTING_STARTED.md
GuptaPratik02 Oct 24, 2023
c2ce7d0
Rectified flutter-dev EXAMPLES.md
GuptaPratik02 Oct 24, 2023
daec743
Rectified flutter GETTING_STARTED.md
GuptaPratik02 Oct 24, 2023
7791cdc
Rectified flutter EXAMPLES.md
GuptaPratik02 Oct 24, 2023
eefbc68
Update web GETTING_STARTED.md
GuptaPratik02 Oct 24, 2023
f287e60
Merge branch 'main' into doc-sdks-python-update-getting-started-guide
Feb 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/sdks/android/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,10 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos
val account = Account(client)
val response = account.create(
ID.unique(),
"email@example.com",
"password"
"email@example.com",
"+123456789",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method does not take a phone number

"password",
"Walter O'Brien"
)
```

Expand All @@ -72,8 +74,10 @@ val client = Client(context)
val account = Account(client)
val user = account.create(
ID.unique(),
gewenyu99 marked this conversation as resolved.
Show resolved Hide resolved
"email@example.com",
"password"
"email@example.com",
"+123456789",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method does not take a phone number

"password",
"Walter O'Brien"
)
```

Expand All @@ -82,7 +86,7 @@ The Appwrite Android SDK raises an `AppwriteException` object with `message`, `c

```kotlin
try {
var user = account.create(ID.unique(), "email@example.com", "password")
var user = account.create(ID.unique(),"email@example.com","+123456789","password","Walter O'Brien")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Log.d("Appwrite user", user.toMap())
} catch(e : AppwriteException) {
e.printStackTrace()
Expand All @@ -94,4 +98,4 @@ You can use the following resources to learn more and get help
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-android)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite Android Playground](https://github.com/appwrite/playground-for-android)
- 🚂 [Appwrite Android Playground](https://github.com/appwrite/playground-for-android)
16 changes: 10 additions & 6 deletions docs/sdks/apple/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,11 @@ let account = Account(client)

do {
let user = try await account.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
gewenyu99 marked this conversation as resolved.
Show resolved Hide resolved
email: "email@example.com",
phone: "+123456789",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

password: "password",
name: "Walter O'Brien"
)
print(String(describing: user.toMap()))
} catch {
Expand All @@ -100,9 +102,11 @@ func main() {

do {
let user = try await account.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

password: "password",
name: "Walter O'Brien"
)
print(String(describing: account.toMap()))
} catch {
Expand Down
10 changes: 6 additions & 4 deletions docs/sdks/dart/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Create a new user:
Users users = Users(client);

User result = await users.create(
userId: '[USER_ID]',
email: 'email@example.com',
password: 'password',
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "Walter O'Brien"
);
```

Expand Down Expand Up @@ -57,4 +59,4 @@ storage.createFile(
});
```

All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
4 changes: 2 additions & 2 deletions docs/sdks/dart/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ void main() async {
Users users = Users(client);

try {
final user = await users.create(userId: ID.unique(), email: email@example.com’,password: password, name: ‘name’);
final user = await users.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
print(e.message);
Expand All @@ -31,7 +31,7 @@ The Appwrite Dart SDK raises `AppwriteException` object with `message`, `code` a
Users users = Users(client);

try {
final user = await users.create(userId: ID.unique(), email: email@example.com’,password: password, name: ‘name’);
final user = await users.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/deno/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```typescript
let users = new sdk.Users(client);

let user = await users.create(ID.unique(), 'email@example.com', 'password');
let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
console.log(user);
```

Expand All @@ -39,7 +39,7 @@ client
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

let user = await users.create(ID.unique(), 'email@example.com', 'password');
let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
console.log(user);
```

Expand All @@ -50,7 +50,7 @@ The Appwrite Deno SDK raises `AppwriteException` object with `message`, `code` a
let users = new sdk.Users(client);

try {
let user = await users.create(ID.unique(), 'email@example.com', 'password');
let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(e) {
console.log(e.message);
}
Expand Down
6 changes: 4 additions & 2 deletions docs/sdks/dotnet/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ var users = new Users(client);
var user = await users.Create(
userId: ID.Unique(),
gewenyu99 marked this conversation as resolved.
Show resolved Hide resolved
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "name");
name: "Walter O'Brien");

Console.WriteLine(user.ToMap());
```
Expand All @@ -35,8 +36,9 @@ try
var user = await users.Create(
userId: ID.Unique(),
gewenyu99 marked this conversation as resolved.
Show resolved Hide resolved
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "name");
name: "Walter O'Brien");
}
catch (AppwriteException e)
{
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/flutter-dev/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Create a new user and session:
```dart
Account account = Account(client);

final user = await account.create(userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name');
final user = await account.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");

final session = await account.createEmailSession(email: 'me@appwrite.io', password: 'password');

Expand Down Expand Up @@ -60,4 +60,4 @@ storage.createFile(
});
```

All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
4 changes: 2 additions & 2 deletions docs/sdks/flutter/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Create a new user and session:
```dart
Account account = Account(client);

final user = await account.create(userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name');
final user = await account.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");

final session = await account.createEmailSession(email: 'me@appwrite.io', password: 'password');

Expand Down Expand Up @@ -60,4 +60,4 @@ storage.createFile(
});
```

All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
12 changes: 3 additions & 9 deletions docs/sdks/flutter/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,7 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos
Account account = Account(client);
final user = await account
.create(
userId: ID.unique(),
email: 'me@appwrite.io',
password: 'password',
name: 'My Name'
userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien"
);
```

Expand All @@ -133,10 +130,7 @@ void main() {

final user = await account
.create(
userId: ID.unique(),
email: 'me@appwrite.io',
password: 'password',
name: 'My Name'
userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien"
);
}
```
Expand All @@ -148,7 +142,7 @@ The Appwrite Flutter SDK raises `AppwriteException` object with `message`, `type
Account account = Account(client);

try {
final user = await account.create(userId: ID.unique(), email: email@example.com’,password: password, name: ‘name’);
final user = await account.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
Expand Down
6 changes: 6 additions & 0 deletions docs/sdks/kotlin/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ val users = Users(client)
val user = users.create(
user = ID.unique(),
email = "email@example.com",
phone = "+123456789",
password = "password",
name = "Walter O'Brien"
)
```

Expand All @@ -48,7 +50,9 @@ suspend fun main() {
val user = users.create(
user = ID.unique(),
email = "email@example.com",
phone = "+123456789",
password = "password",
name = "Walter O'Brien"
)
}
```
Expand All @@ -68,7 +72,9 @@ suspend fun main() {
val user = users.create(
user = ID.unique(),
email = "email@example.com",
phone = "+123456789",
password = "password",
name = "Walter O'Brien"
)
} catch (e: AppwriteException) {
e.printStackTrace()
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/nodejs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```js
let users = new sdk.Users(client);

let promise = users.create(sdk.ID.unique(), 'email@example.com', undefined, 'password', 'Jane Doe');
let promise = users.create(sdk.ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");

promise.then(function (response) {
console.log(response);
Expand All @@ -45,7 +45,7 @@ client
;

let users = new sdk.Users(client);
let promise = users.create(sdk.ID.unique(), 'email@example.com', undefined, 'password', 'Jane Doe');
let promise = users.create(sdk.ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");

promise.then(function (response) {
console.log(response);
Expand All @@ -61,7 +61,7 @@ The Appwrite Node SDK raises `AppwriteException` object with `message`, `code` a
let users = new sdk.Users(client);

try {
let res = await users.create(sdk.ID.unique(), 'email@example.com', 'password');
let res = await users.create(sdk.ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(e) {
console.log(e.message);
}
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/php/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```php
$users = new Users($client);

$user = $users->create(ID::unique(), 'email@example.com', 'password');
$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
```

### Full Example
Expand All @@ -40,7 +40,7 @@ $client

$users = new Users($client);

$user = $users->create(ID::unique(), 'email@example.com', 'password');
$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
```

### Error Handling
Expand All @@ -49,7 +49,7 @@ The Appwrite PHP SDK raises `AppwriteException` object with `message`, `code` an
```php
$users = new Users($client);
try {
$user = $users->create(ID::unique(), 'email@example.com', 'password');
$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(AppwriteException $error) {
echo $error->message;
}
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/python/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```python
users = Users(client)

result = users.create('[USER_ID]', 'email@example.com', 'password')
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
```

### Full Example
Expand All @@ -43,7 +43,7 @@ client = Client()

users = Users(client)

result = users.create(ID.unique(), 'email@example.com', 'password')
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
```

### Error Handling
Expand All @@ -52,7 +52,7 @@ The Appwrite Python SDK raises `AppwriteException` object with `message`, `code`
```python
users = Users(client)
try:
result = users.create(ID.unique(), 'email@example.com', 'password')
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
except AppwriteException as e:
print(e.message)
```
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/ruby/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```ruby
users = Appwrite::Users.new(client);

user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
```

### Full Example
Expand All @@ -40,7 +40,7 @@ client

users = Appwrite::Users.new(client);

user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
```

### Error Handling
Expand All @@ -50,7 +50,7 @@ The Appwrite Ruby SDK raises `Appwrite::Exception` object with `message`, `code`
users = Appwrite::Users.new(client);

begin
user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
rescue Appwrite::Exception => error
puts error.message
end
Expand Down
16 changes: 10 additions & 6 deletions docs/sdks/swift/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ let users = Users(client)

do {
let user = try await users.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "Walter O'Brien"
)
print(String(describing: user.toMap()))
} catch {
Expand All @@ -51,9 +53,11 @@ func main() {

do {
let user = try await users.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "Walter O'Brien"
)
print(String(describing: user.toMap()))
} catch {
Expand Down