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

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

appwrite baas hacktoberfest mbaas node-js

Last synced: about 1 month ago
JSON representation

Simple examples that help you get started with Appwrite + Node.js (=❤️)

• Host: GitHub
• URL: https://github.com/appwrite/playground-for-node
• Owner: appwrite
• Created: 2020-08-22T08:10:14.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-11T19:01:41.000Z (11 months ago)
• Last Synced: 2024-06-07T08:34:37.555Z (3 months ago)
• Topics: appwrite, baas, hacktoberfest, mbaas, node-js
• Language: JavaScript
• Homepage: https://appwrite.io
• Size: 63.5 KB
• Stars: 62
• Watchers: 19
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-appwrite - Playground for Node.js

README

        
# Appwrite's Node.js Playground 🎮

Appwrite playground is a simple way to explore the Appwrite API & Appwrite Node.js SDK. Use the source code of this repository to learn how to use the different Appwrite Node.js SDK features.

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

**Work in progress**

## Get Started

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

## Requirements

* A system with NodeJS 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 `app.js` file found in the root of the cloned repository.

4. Copy Project ID, endpoint and API key from Appwrite console into `app.js`

5. Run the playground:

    NodeJS:

        - Install dependencies `npm install`

        - Execute the command `node app.js`

    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.