phundrak
/
appwrite.el
mirror of https://github.com/Phundrak/appwrite.el.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An Appwrite server SDK for Emacs
14 Commits
1 Branch
0 Tags
64 KiB
Emacs Lisp 90.4%
Makefile 9.6%
 
 
Go to file
Lucien Cartier-Tilet 3a379f5959
Update README 		2022-07-14 15:32:50 +02:00
.github/workflows Remove Windows from CI 2022-07-13 16:04:20 +02:00
.dir-locals.el Fix formatting of docstring 2022-07-13 15:49:50 +02:00
.gitignore initial commit 2022-07-13 02:01:17 +02:00
CONTRIBUTING.org initial commit 2022-07-13 02:01:17 +02:00
Eask Please the linter, bump supported Emacs version to 27 2022-07-13 15:56:46 +02:00
LICENSE initial commit 2022-07-13 02:01:17 +02:00
Makefile initial commit 2022-07-13 02:01:17 +02:00
README.org Update README 2022-07-14 15:32:50 +02:00
TODOs.org Add file listing and retrieving file’s JSON representation 2022-07-13 18:55:45 +02:00
appwrite.el Add file listing and retrieving file’s JSON representation 2022-07-13 18:55:45 +02:00

README.org

appwrite.el

file:<img src=" title="file: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.

Table of contents   TOC_2_gh

How complete is this SDK anyways?

appwrite.el is currently in its infancy, so don’t 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 (Github’s parsing of org-mode files isn’t 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

Contributing

See /phundrak/appwrite.el/src/branch/main/CONTRIBUTING.org.

License

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