# Resumos MEEC

# Introdução

Bem vindos ao site comunitário de resumos de MEEC.
Criado por um grupo de alunos gostosos e baseado no site de LEIC-A.

# Contribuidores 💛

# Como Contribuir

# Instalar Ferramentas

Para correr o código localmente, é necessário instalar as seguintes ferramentas: git e nodejs.

# Verificar se já tens o nodejs instalado e atualizado

npm -v  #verifica se tens o npm instalado e mostra-te a versao
npm i -g npm #atualizar para a versao mais recente (7.--)

# Se ainda precisares de Instalar:

# Windows

Fazer download do git (opens new window) e instalar o executável.
Fazer download do node (opens new window) e instalar a última versão LTS (à data, 14.X LTS).

# Linux

Instalar o git e o node pelo package manager da distribuição. Atenção que o node em Debian/Ubuntu/etc está desatualizado. Recomendo seguir este tutorial (opens new window) para ter o Node 14 LTS.

# Contribuir

Fazer fork do repositório no GitHub, clickar no botão "Fork" no canto superior direito;
Fazer clone da vossa fork:

git clone https://github.com/<vosso username do github>/resumos-meec.git

Dar setup do remote upstream

cd resumos-meec #ir para a pasta certa
git remote add upstream https://github.com/SparklingRita/resumos-meec.git

Instalar dependências

npm i

# Alterar conteúdos

WARNING

Antes de alterar qualquer conteúdo, deves criar um novo branch apenas para essa alteração. Não deves repetir nomes de branches.

Para o fazer no VSCode, faz Ctrl+Shift+P , seleciona Git: Create Branch From , depois dá um nome (ex: acomp-aula1) e seleciona main.

Para fazer o mesmo, mas pelo terminal, é necessário o comando:

git checkout -b nome-do-branch

Para contribuires com os teus próprios resumos, precisas de editar os ficheiros .md (ficheiros markdown) que estão na pasta src.
Para alterar os links na sidebar, é necessário alterar o ficheiro src/.vuepress/config.js para o respetivo tema/título da matéria.
Se nunca trabalhaste com esta linguagem, tens aqui (opens new window) um guia para te ajudar, é bastante simples. Para equações matemáticas, usa-se KateX (semelhante ao LateX), se precisarem de ajuda, está aqui (opens new window) um guia.

Para iniciar o servidor local, para ver como ficou, correr o comando:

npm run dev

# Últimos passos

Já está praticamente tudo feito, basta fazer commit e push pela interface do VSCode, ou então, pelo terminal:

git add .
git commit -m "mensagem"
git push

TIP

Se forem ao site e ainda não estiver lá, não se preocupem, demora algum tempo. Só serão aceites resumos que realmente acrescentem algo, para que não haja repetição de conteúdos. Agradecemos todas as contribuições 😃

# Para as próximas vezes

Caso seja a primeira vez que estão a contribuir, este passo não é necessário, só precisarão para as próximas contribuições. Antes de voltar a fazer alterações, tem de ser necessário atualizar a fork, para isso, têm de voltar para o branch main, fazer pull do upstream e push para o origin:

git checkout main
git pull upstream main
git push

A partir daqui, é criar um novo branch e fazer as alterações, tal como da última vez.

# Abrir um Pull-Request no GitHub

Para podermos adicionar os vossos resumos ao site, é preciso criarem um pull request no GitHub, para isso, basta irem a este link (opens new window) e selecionar o vosso branch.