appwrite.el/README.org

2.1 KiB
Raw Blame History

appwrite.el

https://github.com/Phundrak/appwrite.el/actions/workflows/test.yml/badge.svg

Introduction

appwrite.el is a server SDK for Appwrite, a self-hosted backend-as-a-service platform.

How complete is this SDK anyways?

appwrite.el is currently in its infancy, so dont expect yet most of the functionalities to be available. If you want to see a detailed view of the parity between this library and the server API, check out the TODOs file in this repository (Githubs parsing of org-mode files isnt great, either read it raw, on my Gitea mirror, or directly in Emacs).

Installation

Manual Installation

To manually install appwrite.el, clone the repository wherever you want, then put the path to the repository in your load-path. You can then require it.

(add-to-list 'load-path "path/to/your/appwrite.el/")
(require 'appwrite)

Straight + use-package

You can also let straight with use-package manage the git repository themselves. For that, you can use this as your minimal config for installing appwrite.el:

(use-package appwrite
  :straight (appwrite :git host
                      :repo "https://labs.phundrak.com/phundrak/appwrite.el"))

Customizing

License

appwrite.el is available under the GNU GPL-3.0 license. You can find the full text in the LICENSE file.