Site da Comissão de Recepção de 2021 até 2024

Esse repositório contém todo o código fonte do site estático usado nas comissões de recepção de 2021 até 2024.

Tecnologias Usadas

• Yarn
• Nuxt.js
• Vuetify.js

Fluxo de trabalho

Esse repositório não aceita commits diretamente na branch principal, para contribuir para o desenvolvimento você deve:

• Criar uma nova branch (caso não saiba como fazer isso, olhe aqui)
• Abrir um pull request
• Fazer os seus commits nessa nova branch
• Passar no teste de linter (Não é obrigatório o teste de linter estar passando para o pull request ser aprovado, mas para manter uma boa pŕatica, tente sempre manter o teste de linter passando antes de aceitar o pull request)
• Pedir para alguém revisar o pull request quando terminar de desenvolver (Obrigatório no mínimo uma revisão)
• Esperar o pull request ser aceito

Pré-requisitos

Antes de fazer qualquer um dos passos seguintes, você deve instalar no seu computador o node.js, NPM (normalmente já vem junto com o node.js) e o yarn. Após isso, siga os seguintes passos:

• Clone o repositório
• Na pasta raiz do projeto, execute:

  $ yarn install

  Esse commando irá instalar todas as dependências necessárias para você.

Como desenvolver?

Servidor de desenvolvimento

• Na pasta raiz do projeto, execute:

  $ yarn dev

  Esse comando irá executar um servidor de desenvolvimento que atualiza automaticamente conforme você edita os arquivos, normalmente no link localhost:3000.

Linter

O Linter é uma ferramenta de análise de código para ajudar a manter um código mais organizado e limpo, por isso, tente sempre ficar ligado nos warnings.

Para verificar os problemas de lint, execute:

$ yarn lint

Para corrigir automaticamente os problemas de lint, execute:

$ yarn lint --fix

Obs:

• Note que nem todos os problemas de lint são resolvidos por esse comando.
• Execute esse comando sempre que possível para o teste de linter não falhar no seu pull request.

Como gerar o site estático?

Para gerar o site estático, execute os seguintes comandos:

$ yarn build
$ yarn generate

O site estático estará na pasta /dist. Para testar como o site ficará no site oficial, execute o seguinte comando:

$ yarn start

Esse comando irá servir o site através dos arquivos estáticos, simulando como se estivesse dentro dos servidores do ime, ou seja, como se já estivesse no domínio http://recepcao.ime.usp.br/

Como atualizar o site oficial?

Obs: Para essa etapa você precisa das credenciais do SSH da comissão no servidor do ime.

• Após gerar o site estático, no diretório raiz, copie a pasta /dist para dentro da máquina do ime através desse comando:

  $ scp -r dist comissaoderecepcao@ime.usp.br:~/

• Logue na máquina do ime através do ssh
• Apague todos os arquivos de dentro da pasta www
• Copie todos os arquivos de dentro da pasta dist para a pasta www

Dicas

Como criar uma nova branch?

Para trabalhar em uma nova branch, execute:

$ git checkout -b nome_da_branch

(Esse comando irá criar e mudar para a nova branch automaticamente).

Após criar a branch, para envia-la para o repositório remoto (github) execute o seguinte comando:

$ git push -u origin nome_da_branch

Depois disso é só abrir seu pull request.

Como ver todas as branches?

Execute:

$ git branch

Como mudar de branch?

Execute:

$ git checkout nome_da_branch