https://github.com/appwrite/playground-for-deno

Simple examples that help you get started with Appwrite + Deno (=❤️)
https://github.com/appwrite/playground-for-deno

appwrite baas deno denoland hacktoberfest mbaas

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/appwrite/playground-for-deno
• Owner: appwrite
• License: bsd-3-clause
• Created: 2020-07-15T06:38:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-19T13:24:43.000Z (3 months ago)
• Last Synced: 2024-09-27T06:23:27.253Z (3 months ago)
• Topics: appwrite, baas, deno, denoland, hacktoberfest, mbaas
• Language: TypeScript
• Homepage: https://appwrite.io
• Size: 59.6 KB
• Stars: 31
• Watchers: 16
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-appwrite - Playground for Deno

README

        
# Playground for Deno

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

**Work in Progress**

Appwrite playground for Deno is a simple way to explore the Deno integration with Appwrite SDK. Use the source code to understand how to use the different Appwrite SDK features with Deno.

## Get Started

This playground doesn't include any deno best practices but rather intended to show some of the most simple examples and use cases of using the Appwrite API in your deno application.

## Requirements

* A system with Deno or Docker installed.

* An Appwrite instance.

* An Appwrite project created in the console.

* An Appwrite API key created in the console.

### Installation

1. Clone this repository.

2. `cd` into the repository.

3. Open the `mod.ts` file found in the root of the cloned repository.

4. Copy Project ID, endpoint and API key from Appwrite console into `mod.ts`

5. Run the playground:

    Deno:

        - Install dependencies `deno cache src/mod.ts`

        - Execute the command `deno run -A src/mod.ts`

    Docker:

        - Execute the command `docker compose up`

6. You will see the JSON response in the console.

### API's Covered

- Databse

    * Create Collection

    * List Collections

    * Delete Collection

    * Create Document

    * List Documents

    * Delete Document

- Storage

    * Create Bucket

    * List Buckets

    * Delete Bucket

    * Upload File

    * List Files

    * Delete File

- Users

    * Create User

    * List Users

    * Delete User

- Functions

    * Create Function

    * List Functions

    * Delete Function

    * Upload Deployment

    * Execute function (sync)

    * Execute function (async)

## 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.

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).

## Security

For security issues, kindly email us [[email protected]](mailto:[email protected]) instead of posting a public issue in GitHub.

## Follow Us

Join our growing community around the world! Follow us on [Twitter](https://twitter.com/appwrite), [Facebook Page](https://www.facebook.com/appwrite.io), [Facebook Group](https://www.facebook.com/groups/appwrite.developers/) or join our [Discord Server](https://appwrite.io/discord) for more help, ideas and discussions.