Cover Image by @Atinux
nuxt-appwrite
Appwrite is a self-hosted solution that provides developers with a set of easy-to-use and integrate REST APIs to manage their core backend needs. This module is made to connect Appwrite SDKs to Nuxt more easily.
Docs
Release Notes
Setup
First, add nuxt-appwrite
dependency to your project
npx nuxi@latest module add appwrite
Next, add nuxt-appwrite
to the modules
section of nuxt.config
export default {
modules: ['nuxt-appwrite'],
appwrite: {
/* module options */
}
}
Options
API endpoint - endpoint
- type:
String
- default:
https://cloud.appwrite.io/v1
Appwrite API endpoint (Console -> Project -> Setting -> API Endpoint)
Project ID - project
- type:
String
- default:
null
Appwrite project ID (Console -> Project -> Setting -> Project ID)
Full Example
export default {
modules: [
'nuxt-appwrite'
],
appwrite: {
endpoint: 'https://cloud.appwrite.io/v1',
project: 'nuxt-playground',
}
}
Usage
Using useAppwrite
composable:
const { account } = useAppwrite()
try {
const res = await account.get()
console.log(res)
} catch (err) {
console.log(err)
}
Server Side User Action
Currently Not Supported
Development
- Clone this repository
- Install dependencies using
yarn install
or npm install
- Start development server using
npm run dev
License
MIT License
Copyright (c) Herdi Tr. iam@icm.hrdtr.dev