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

Removed grammatical errors from Readme.md #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
Removed grammatical errors from Readme.md
gams0318 committed Oct 4, 2023

Verified

This commit was signed with the committer’s verified signature. The key has expired.
universalmind303 Cory Grinstead
commit 6e6be745b71919558d06c8e95bc964a4b4192671
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,31 +2,31 @@

Simple examples that help you get started with Appwrite + Dart (=❤️)

This is Appwrite server side integration with Dart. For Flutter integration please look at our [Flutter playground](https://github.com/appwrite/playground-for-flutter) and [Flutter SDK](https://github.com/appwrite/sdk-for-flutter)
This is Appwrite server-side integration with Dart. For Flutter integration please look at our [Flutter playground](https://github.com/appwrite/playground-for-flutter) and [Flutter SDK](https://github.com/appwrite/sdk-for-flutter)

### Work in progress

Appwrite playground is a simple way to explore the Appwrite API and Appwrite Dart SDK. Use the source code of this page to learn how to use different Appwrite Dart SDK features.

## Get Started
This playground doesn't include any dart best practices, but rather intended to show some of the most simple examples and use cases of using the Appwrite API in your dart application.
This playground doesn't include any Dart best practices but rather intends to show some of the most simple examples and use cases of using the Appwrite API in your Dart application.

## System Requirements
* A Linux/Windows/Mac system with Dart or Flutter installed
* You have readily available Appwrite running instance (localhost in most cases).
* Have a readily available Appwrite running instance (localhost in most cases).
* Create a project in Appwrite instance using console
* Generate a secret key in the Appwrite instance using console

### Installation
1. Clone this repository
2. cd into the repository
3. Open main.dart file found in the root of the cloned repository
4. Copy the project_id, endpoint, secret key from the Appwrite Console
5. Update project_id, endpoint, secret key by copying from the console in the main.dart file
4. Copy the project_id, endpoint, and secret key from the Appwrite Console
5. Update project_id, endpoint, and secret key by copying from the console in the main.dart file
6. Execute the command `dart run main.dart`
7. You will see the JSON response in the console

### API Covered in Playground.
### API Covered in Playground
* Create Collection
* List Collection
* Add Document
@@ -37,7 +37,7 @@ This playground doesn't include any dart best practices, but rather intended to

## Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.
All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md).