pspdfkit web example pwa

PSPDFKIT PARA EXEMPLO DE WEB - PWA

Este exemplo mostra como integrar o PSPDFKIT para Web e criar um PWA (Progressive Web App).

Você pode conferir uma visualização ao vivo aqui: Pspdfkit.com/pwa.

Este aplicativo de amostra possui uma configuração básica de PWA, incluindo um manifesto e um trabalhador de serviço, para permitir que seu aplicativo funcione offline, bem como um armazenamento indexedDB para PDFs. Dessa forma, seus arquivos são persistidos mesmo depois de você fechar o navegador.

Neste exemplo, usamos Workbox, uma estrutura popular da PWA pelo Google.

Pré -requisitos

• Node.js
• Um PSPDFKIT para licença da web. Se você ainda não possui um, pode solicitar uma avaliação gratuita aqui.

Suporte, questões e perguntas de licença

O PSPDFKIT oferece suporte para clientes com uma licença SDK ativa via https://pspdfkit.com/support/request/

Você está avaliando nosso SDK? Isso é ótimo, estamos felizes em ajudar! Para garantir que isso seja rápido, use um e -mail de trabalho e peça a alguém da sua empresa preencher nosso formulário de vendas: https://pspdfkit.com/sales/

Começando

Clone o repo:

git clone https://github.com/PSPDFKit/pspdfkit-web-example-pwa.git
cd pspdfkit-web-example-pwa

Instale as dependências do projeto com npm :

npm install

Agora que tudo está instalado, precisamos configurar o aplicativo para usar nossa chave de licença PSPDFKit para a Web.

Edit ./config/license-key e substitua a string YOUR_LICENSE_KEY_GOES_HERE pela chave de licença que você recebeu por e-mail.

Executando o exemplo

Estamos prontos para lançar o aplicativo! ?

Para executar o aplicativo no modo de desenvolvimento:

npm run start

Construir artefatos de produção

Para construir uma versão de produção, basta seguir o guia acima, mas em vez de executar start :

npm run build

O script de compilação criará um arquivo chamado ./dist que você pode copiar para o seu servidor da web as-is.

Como funciona

Em ./src você pode encontrar um shell de aplicativo simples que carregue PSPDFKIT para Web.

O aplicativo usa um trabalhador de serviço para fornecer suporte offline e pré-cache para a maioria dos ativos.

Para reduzir a quantidade de caldeira, usamos Workbox - uma biblioteca do Google que abstrairá parte da verbosidade associada à criação e configuração do trabalhador do serviço.

Também usamos o WorkBox-Cli, outra biblioteca do Google, para gerar automaticamente um arquivo de manifesto para o nosso serviço de serviço do serviço de serviço quando executamos npm start . Você pode encontrar esse arquivo de configuração em ./src/workbox-config.js .

Para permitir que os PDFs sejam persistidos localmente para que eles não precisem ser baixados novamente, criamos a biblioteca PSPDFKitFileStore . Ele usa um invólucro leve e baseado em Promise em torno da API IndexedDB chamada idb sob o capô. O código foi projetado para funcionar independentemente do exemplo da PWA e também pode ser usado no Internet Explorer 11.

Suporte móvel

Se você tentar se conectar ao servidor de desenvolvimento local remotamente, verá rapidamente que o PWA não está funcionando como esperado. Isso se deve ao fato de as APIs da PWA exigir um certificado SSL/TLS válido para funcionar corretamente e você provavelmente não terá essa configuração localmente.

Para uma experiência melhor, sugerimos que você confira o exemplo da PWA hospedada ou implante uma criação de produção no seu próprio servidor.

Licença

Este software está licenciado sob uma licença BSD modificada.

Contribuindo

Certifique -se de assinar nosso CLA para que possamos aceitar suas contribuições.