danielpbl/cefet-web-weblot

Um conjunto de códigos ilustrativos de APIs do HTML5

O Reino de Weblot 👑

Um conjunto de códigos ilustrativos de APIs do HTML5.

#comofaz?

Conforme o enunciado diz, o trabalho é composto por uma (a) apresentação de seminário, mais a criação e entrega de um (b) projeto de código simples ilustrando cada API escolhida pelo grupo.

O projeto (b) deve ser entregue como um Pull Request (veja [1] e [2]) neste repositório. Ou seja, um (01) membro do grupo deve:

1. 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
2. Criar um branch com nome 'ano/semestre' (e.g., 2018/02);

   git branch 2018/02
   

   ou então (eu gosto mais, porque cria o branch e já muda pra ele):

   git checkout -b 2018/02
   

3. Criar, dentro da pasta /apis, uma pasta 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á. Deve haver uma pasta dessa para cada API que você escolheu
4. Alterar o arquivo apis.json (na raiz) colocando as metainformações sobre cada API que o grupo escolheu (sem remover a que está lá). Você deve ver o exemplo da API de drag'n'drop e fazer da mesma forma:

   {
     "semestre": "2018/01",
     "apis": [
       {
         "nome": "Drag and Drop API",
         "breveDescricao": "Possibilita o arraste de elementos HTML em cima de outros",
         "paginaInicial": "apis/drag-and-drop/",
         "screenshot": "apis/drag-and-drop/images/screenshot.png",
         "desenvolvedores": [
           {
             "nome": "Flávio Coutinho",
             "usuarioGithub": "fegemo"
           }
         ],
         "suporteDeNavegadores": {
           "chrome": true,
           "safari": true,
           "firefox": true,
           "edge": true,
           "opera": true
         }
       },
       {
         "nome": "MINHA API",
         "breveDescricao": "MINHA DESCRIÇÃO... etc."
       }
     ]
   }

• Não se esqueça de colocar uma vírgula entre o objeto que representa a API "Drag and Drop" e o objeto que você vai criar para representar a sua(s) API(s)

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. Procure seguir a mesma ideia e formato (bonitão, criativão).

O que deve conter

Seu código deve conter uma ilustração simples, porém interessante, de uso de cada API escolhida. Procure separar os arquivos do código fonte em pastas (e.g., styles, scripts, images etc.).

No diretório raiz de cada exemplo (e.g., /apis/drag-and-drop/) deve haver um arquivo index.html com a página inicial (e provavelmente a única), que será a "porta de entrada" do exemplo.

Além disso, crie um arquivo README.md (formato Markdown - veja [3] e [4]) para cada API escolhida contendo pelo menos três seções (a exemplo README.md da API de drag and drop):

1. API xyz
   • Breve descrição da API (uma linha)
   • Uma screenshot do seu exemplo rodando
2. Links do Exemplo
   • Link para seus slides do seminário
   • Link para exemplo vivo (formato: https://fegemo.github.io/cefet-web-weblot/apis/PASTA_DO_SEU_PROJETO/)
3. Créditos
   • Indicação de quem são os autores   - Texto dando a devida atribuição aos eventuais recursos de terceiros usados (imagens, música, código fonte etc.)

Enviando

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 fork no Github e clique em "Pull Request":

Nessa tela, você deve escolher o seu branch (ano/semestre) como origem e o branch (ano/semestre) do repositório original como destino (e não o master).