sdk for web

AppWrite Web SDK

Este SDK é compatível com o AppWrite Server versão 1.6.x. Para versões mais antigas, verifique os lançamentos anteriores.

O AppWrite é um back-end de código aberto como um servidor de serviço que abstrata e simplifica tarefas de desenvolvimento complexas e repetitivas por trás de uma API REST muito simples de usar. O AppWrite pretende ajudá -lo a desenvolver seus aplicativos mais rapidamente e de uma maneira mais segura. Use o Web SDK para integrar seu aplicativo ao AppWrite Server para começar facilmente a interagir com todas as APIs e ferramentas de back -end do AppWrite. Para documentação completa da API e tutoriais, acesse https://appwrite.io/docs

Instalação

Npm

Para instalar via NPM:

npm install appwrite --save

Se você estiver usando um empacota (como rollup ou webpack), poderá importar o módulo AppWrite quando precisar:

 import { Client , Account } from "appwrite" ;

CDN

Para instalar com um CDN (rede de entrega de conteúdo), adicione os seguintes scripts à parte inferior da sua tag, mas antes de usar qualquer serviço AppWrite:

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

Começando

Adicione sua plataforma web

Para você iniciar seu SDK e interagir com os serviços AppWrite, você precisa adicionar uma plataforma da Web ao seu projeto. Para adicionar uma nova plataforma, vá ao seu console AppWrite, escolha o projeto que você criou na etapa antes e clique no botão 'Adicionar plataforma'.

Nas opções, escolha adicionar uma plataforma da web e adicionar seu nome de host do aplicativo cliente. Ao adicionar seu nome de host à sua plataforma de projeto, você está permitindo a comunicação entre domínios entre o seu projeto e a API AppWrite.

Inicie seu SDK

Inicialize seu SDK com o seu endpoint API AppWrite Server e ID do projeto, que podem ser encontrados na página Configurações do projeto.

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

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

Faça seu primeiro pedido

Depois que seu objeto SDK estiver definido, acesse qualquer um dos Serviços AppWrite e escolha qualquer solicitação para enviar. A documentação completa para qualquer método de serviço que você gostaria de usar pode ser encontrada na sua documentação SDK ou na seção Referências da 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 ) ;
    } ) ;

Exemplo 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 ) ;
    } ) ;

Saber mais

Você pode usar os seguintes recursos para aprender mais e obter ajuda

• Tutorial de início
• Documentos AppWrite
• Comunidade Discord
• ? AppWrite Web Playground

Contribuição

Esta biblioteca é gerada automaticamente pelo AppWrite Custom SDK Generator. Para saber mais sobre como você pode nos ajudar a melhorar este SDK, verifique o guia de contribuição antes de enviar uma solicitação de tração.

Licença

Consulte o arquivo de licença BSD-3-cláusula para obter mais informações.