Cria a tua primeira webpart com SPFx em menos de 10 minutos
Olá a todos!
Neste artigo, vou explicar passo a passo como podem criar a vossa primeira webpart utilizando o SharePoint Framework e como a podem publicar num site SharePoint.
1. Criação de webpart
- Existem 5 requisitos principais para se poder se poder criar uma webpart
- Node.js instalado
- Se viram o video sobre como instalar o NVM então já o devem ter instalado
- A versão recomendada para um novo projeto com a Versão corrente de SPFX (1.21) é a latest version 22.16.0
- Conta com acesso ao SharePoint para poder testar e fazer deploy
- Se seguiram o video de como criar um developer tenant até ao fim já têm o ambiente criado, só precisam de um site de SharePoint
- Yeoman e gerador SPFx
- Pacotes para poder gerar a solução
- comandos
- npm install yo --global
- npm install @microsoft/generator-sharepoint --global
- Gulp
- Serve para compilar a solução
- comandos
- npm install gulp-cli --global
- VS code
- É editor que recomendo para editar o vosso projeto, tem muitas extensões úteis
- https://code.visualstudio.com/
- Após o setup terminado, abrimos o powershell e colocamos-nos onde queremos criar o projeto
- Criamos uma pasta, que é onde irá ficar toda a informação do projeto
- md aminha1webpart
- mudamos para essa pasta
- cd .\aminha1webpart\
- Corremos o comando e preenchemos os campos como vemos abaixo
- yo @microsoft/sharepoint
- solution name: aminhasolucao
- tipo de componente: webpart
- template: React
- Após selecionar o template o projeto irá ser criado, quando o processo terminar, para abrir o projeto no VS code, corremos
- code .
- Estrutura do projeto
- pasta src
- .vscode/
- Configurações específicas do Visual Studio Code.
- Pode conter configurações de debug, linting, etc.
- config/
- Contém arquivos de configuração para build, como:
- config.json, serve.json, write-manifests.json
- Define como o SPFx constrói, corre e empacota o projeto.
- node_modules/
- Diretório padrão do Node.js com todas as dependências do projeto.
- Gerado automaticamente pelo npm install.
- src/
- Contém o código-fonte principal do projeto SPFx.
- contem as webparts e os componentes
- Antes de arrancar a solução recomendo irmos ao ficheiro, ./config/serve.json e substituir o valor da propriedade initialPage (trocar {tenantdomain} pelo nosso site), de modo a que quando corremos a solução a página aberta seja do nosso site SharePoint
- Após a alteração corremos
- Gulp serve
- Após carregar iremos ver uma pagina em branco, carregamos no "+" e selecionamos a nossa webpart
- Agora fazemos CTRL + C para parar a webpart
2. Deploy
- Para fazermos deploy da webpart temos criar o bundle da solução e para isso corremos o seguinte comando
- gulp bundle --ship
- irá fazer o bundle da solução para depois poder criar o package
- Para a criação do package utilizamos o comando
- gulp package-solution --ship
- Após corrermos estes comandos irá aparecer uma pasta nova chamada sharepoint,é nela que se encontra o package que iremos usar para fazer o deploy
- No tenant que criamos anteriormente foi criado um site de sharepoint chamado /sites/appcatalog
- Neste site carregamos em "Distribute apps for SharePoint"
- Fazemos upload do ficheiro {appName}.sppkg e carregamso em ok
- No popup se quisermos que a nossa app fique disponivel em todos os sites de SharePoint do ambiente em selecionamos a check box senão mantemos a mesma sem preenchimento, que é o caso demonstado abaixo e pressionamos em Deploy.
- Por fim regressamos ao site onde queremos adicionar a aplicação que criámos e vamos a site contents e na opção "New" selecionamos App
- No ecrã seguinte carregamos em "Add" para adicionar a nossa aplicação, quando o botão passar a "Added" a aplicação já se encontra disponivel no site e pronta a usar
Espero que este guia vos tenha sido útil na criação da vossa primeira
webpart utilizando a SharePoint framework. Se preferirem, podem também
assistir ao vídeo onde explico detalhadamente todo o processo de criação e
adicionamento de uma webpart. Fiquem atentos para mais conteúdos e bons
estudos!
Vídeo Tutorial: Cria a tua primeira webpart com SPFx em menos de 10 minutos
Comentários
Enviar um comentário