You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Appwrite playground is a simple way to explore the Appwrite API & Appwrite Ruby SDK. Use the source code of this repository to learn how to use the different Appwrite Ruby SDK features.
Work in progress
Get Started
This playground does not adhere to Ruby best practices but rather is intended to show some of the most simple examples and use cases of using the Appwrite API in your Ruby application. Rubocop is enforced and the configuration can be found at .rubocop.yml
System Requirements
A system with Ruby 2.7+ or Docker installed.
An Appwrite instance.
An Appwrite project created in the console.
An Appwrite API key created in the console.
Installation
Clone this repository.
cd into to the repository.
Open the lib/playground.rb file found in the root of the cloned repository.
Copy Project ID, endpoint and API key from Appwrite console into lib/playground.rb
Run the playground:
Ruby:
- Install dependencies using bundle bundle install
- Execute the command bundle exec ruby lib/playground.rb
Docker:
- Execute the command docker compose up
You will see the JSON response in the console.
API's Covered:
Databse
Create Collection
List Collections
Add Document
List Documents
Delete Document
Delete Collection
Storage
Create Bucket
List Buckets
Upload File
List Files
Delete File
Delete Bucket
Users
Create User
List Users
Delete User
Functions
Create Function
List Functions
Delete Function
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.
Security
For security issues, kindly email us security@appwrite.io instead of posting a public issue in GitHub.