Um conjunto de códigos ilustrativos de APIs do HTML5 (⬅️ clicar).
Conforme o enunciado diz, o trabalho é composto pela criação, entrega e apresentação de um projeto de código simples ilustrando cada API escolhida pelo grupo.
O projeto deve ser entregue como um Pull Request (veja [1] e [2]) neste repositório. Ou seja, um (01) membro do grupo deve:
- Fazer um fork deste repositório e dar permissão de escrita (commit/push) para todos os membros do grupo;
- Clicar no botão fork e, depois, clicar no Settings e procurar
- Trabalhar no branch com nome 'ano/semestre' (e.g.,
20YY/SS
). Por exemplo, se for em2030/01
:git checkout -b 2030/01
- Para cada exemplo que se pretende criar, você deve criar dentro da pasta
/apis
uma pastinha com o nome da sua API de escolha (nome em minúsculo, sem acentos, trocando espaços por de hífens e sem o prefixo ou sufixo API - e.g.,/apis/drag-and-drop/
) e colocar seu código lá.- Se optar por ilustrar mais de uma API em um mesmo exemplo, dê um nome à pasta resumindo todas as APIs usadas. Por exemplo, para APIs de Canvas e Speech Recognition, o nome da pasta seria
apis/canvas-e-speech-recognition/
.
- Se optar por ilustrar mais de uma API em um mesmo exemplo, dê um nome à pasta resumindo todas as APIs usadas. Por exemplo, para APIs de Canvas e Speech Recognition, o nome da pasta seria
- Cada pasta de exemplo deve conter:
- Uma screenshot (preferencialmente quadrada e nor formato
.webp
) - Arquivo
README.md
seguindo o modelo deapis/drag-and-drop/README.md
- Arquivo
apis.json
seguindo o modelo deapis/drag-and-drop/apis.json
, que é um vetor com os dados de cada API usada no seu exemplo. Formato de umapis.json
:[ { "nome": "Drag and Drop API", "breveDescricao": "Possibilita o arraste de elementos HTML em cima de outros", "paginaInicial": "apis/drag-and-drop/", "screenshot": { "caminho": "apis/drag-and-drop/images/screenshot.png", "textoAlternativo": "Uma página com 2 monstrinhos em uma jaula e outros 3 fora com os dizeres 'Prenda os Monstrinhos'" }, "desenvolvedores": [ { "nome": "Flávio Coutinho", "usuarioGithub": "fegemo" } ], "suporteDeNavegadores": { "chrome": true, "safari": true, "firefox": true, "ie": false, "edge": true, "opera": true } }, { "nome": "SEGUNDA API DO MESMO EXEMPLO", "breveDescricao": "MINHA DESCRIÇÃO... etc." } ]
- Sobre o suporte de navegadores, consulte alguma fonte como o caniuse.com para preencher.
- Uma screenshot (preferencialmente quadrada e nor formato
- Alterar o arquivo
examples.json
(na raiz) colocando os nomes das pastas de exemplos (só o nome, não o caminho) que o grupo criou (sem remover a que está lá). Insira a(s) string(s) com nomes de pasta sendo 1 por linha e em ordem alfabética - apenas para tentar reduzir o número de conflitos nesse arquivo ao entregar seu pull request. Por exemplo, para incluir os exemplosapis/battery-status/
eapis/webvr
:- Inicialmente estava assim:
{ "semestre": "2030/01", "pastas": [ "drag-and-drop" ] }
- Ficou assim:
{ "semestre": "2030/01", "pastas": [ "battery-status", "drag-and-drop", "webvr" ] }
- Inicialmente estava assim:
- Abra um servidor web na pasta raiz e veja se está tudo funcionando (verifique o console para erros)
- Quando tudo estiver certo, abra o pull request do seu branch 20XX/SS contra o branch de mesmo nome do repositório do professor
Os membros de um mesmo grupo devem trabalhar no fork criado por apenas 1 integrante, ou seja, aquele que criou o fork deve dar permissão de escrita ao(s) outro(s).
Veja o projeto de exemplo que já está lá, sobre a API de drag and drop: código fonte e o exemplo publicado. Pessoas bonitas seguem a mesma ideia e formato (exemplo simples, porém bonitão, criativão e on-topic).
Como mencionado, o envio será via um pull request. Assim que você der o último git push
para o seu fork,
vá para a página do seu fork no Github e clique em "Pull Request":
Nessa tela, você deve escolher:
- como origem: o seu branch (
ano/semestre
); - como estino: o branch (
ano/semestre
) do repositório original como destino (e não omaster
).