sdk for web

AppWrite web sdk

Este SDK es compatible con AppWrite Server versión 1.6.x. Para versiones anteriores, verifique las versiones anteriores.

AppWrite es un backend de código abierto como un servidor de servicio que abstrae y simplifica las tareas de desarrollo complejas y repetitivas detrás de una API REST muy simple de usar. AppWrite tiene como objetivo ayudarlo a desarrollar sus aplicaciones de manera más rápida y segura. Use el SDK web para integrar su aplicación con el servidor AppWrite para comenzar fácilmente a interactuar con todas las API y herramientas de Backend de AppWrite. Para la documentación y los tutoriales de la API completa, visite https://appwrite.io/docs

Instalación

Npm

Para instalar a través de NPM:

npm install appwrite --save

Si está utilizando un Bundler (como Rollup o Webpack), puede importar el módulo AppWrite cuando lo necesite:

 import { Client , Account } from "appwrite" ;

CDN

Para instalar con un CDN (red de entrega de contenido) Agregue los siguientes scripts al final de su etiqueta, pero antes de usar cualquier servicio de AppWrite:

 < script src =" https://cdn.jsdelivr.net/npm/[email protected] " > </ script > 

Empezando

Agregue su plataforma web

Para que inicie su SDK e interactúe con los servicios de AppWrite, debe agregar una plataforma web a su proyecto. Para agregar una nueva plataforma, vaya a su consola AppWrite, elija el proyecto que creó en el paso antes y haga clic en el botón 'Agregar plataforma'.

De las opciones, elija agregar una plataforma web y agregar el nombre de host de su aplicación de cliente. Al agregar su nombre de host a la plataforma de su proyecto, está permitiendo la comunicación de dominio cruzado entre su proyecto y la API AppWrite.

Init Your SDK

Inicialice su SDK con el punto final API de su servidor de AppWrite e ID de proyecto que se puede encontrar en la página de configuración de su proyecto.

 // Init your Web SDK
const client = new Client ( ) ;

client
    . setEndpoint ( 'http://localhost/v1' ) // Your Appwrite Endpoint
    . setProject ( '455x34dfkj' ) // Your project ID
;

Haz tu primera solicitud

Una vez que se establezca su objeto SDK, acceda a cualquiera de los servicios de AppWrite y elija cualquier solicitud para enviar. La documentación completa para cualquier método de servicio que desee usar se puede encontrar en su documentación SDK o en la sección de referencias de API.

 const account = new Account ( client ) ;

// Register User
account . create ( ID . unique ( ) , "[email protected]" , "password" , "Walter O'Brien" )
    . then ( function ( response ) {
        console . log ( response ) ;
    } , function ( error ) {
        console . log ( error ) ;
    } ) ;

Ejemplo completo

 // Init your Web SDK
const client = new Client ( ) ;

client
    . setEndpoint ( 'http://localhost/v1' ) // Your Appwrite Endpoint
    . setProject ( '455x34dfkj' )
;

const account = new Account ( client ) ;

// Register User
account . create ( ID . unique ( ) , "[email protected]" , "password" , "Walter O'Brien" )
    . then ( function ( response ) {
        console . log ( response ) ;
    } , function ( error ) {
        console . log ( error ) ;
    } ) ;

Obtenga más información

Puede usar los siguientes recursos para obtener más información y obtener ayuda

• Tutorial de inicio
• Docios de AppWrite
• Comunidad de Discord
• ? Plazo web de AppWrite

Contribución

Esta biblioteca se genera automáticamente por el generador SDK personalizado de AppWrite. Para obtener más información sobre cómo puede ayudarnos a mejorar este SDK, consulte la guía de contribución antes de enviar una solicitud de extracción.

Licencia

Consulte el archivo de licencia de cláusula BSD-3 para obtener más información.