Este projeto é escrito em Typescript, com a framework React para os componentes visuais. Engloba apenas o frontend da aplicação, e necessita de comunicar com um backend feito pelo headless CMS Strapi para receber e mostrar dados.
Usa o package manager yarn, a ferramenta de construção vite com a framework vike para funcionalidades adicionais como SSR, gestão de rotas e dados. Erros de lógica e formatação são validados com o ESLint, inspirando-se nas regras do Standard.
Para contribuir para este repositório, ler a secção Contribuir.
É necessário o yarn para correr o projeto, que recomendamos instalar pelo nvm (node version manager).
Começamos por instalar o download do nvm pelo site oficial.
De seguida, corremos
nvm usepara instalar a versão recomendada do npm.
npm install -g corepackirá instalar o package manager yarn.
⚠️ É aconselhado instalar e usar o Visual Studio Code como editor de texto. Há uma lista de extensões recomendadas. Para bom funcionamento do projeto, é necessário instalar também as extensões recomendadas do VS Code, listadas dentro da pasta.vscode.
Para que a app tenha acesso às variáveis de ambiente necessárias, incluindo segredos, copia-se o ficheiro .env.development e renomea-se a cópia para .env.development.local ou .env.local (se for para produção).
Para instalar as dependencias do projeto, é necessário correr
yarn(equivalente a yarn install). Isto deve ser corrido no primeiro clone do projeto, cada vez que se adiciona uma dependência nova ou cada vez que se faz pull de um commit novo através do GitHub.
yarn devCorre a app em modo de desenvolvimento na porta 3000. Abre http://localhost:3000 num browser para veres. A página irá dar reload sempre que guardares alterações, ao mesmo tempo que valida erros de ESlint e Typescript na consola.
Depois de ler atentamente as instruções de instalação, o projeto deverá estar bem configurado localmente.
Este repositório dedica-se exclusivamente à interface em React do site atual do QueerIST.
Qualquer contribuição deverá ser feita através de commits separados mas significativos, sendo que cada deverá ter um propósito objetivo. Não deverá existir commits de merge.
As mensagens de commit seguem um formato específico, começando por um emoji do github delimitado por dois pontos (alusivo à função deste commit), de seguida um verbo em português no presente da terceira pessoa do singular (com a ação deste commit) de uma lista fechada de verbos, e o resto da frase a explicar em mais detalhe o commit.
Este formato assegura consistencia e concisão nas mensagens de commit.
Exemplos de mensagens são:
- ✨ Cria Share componente
- ⚡ Melhora add to calender código e svg
- 🐛 Corrige data de fim de evento no futuro
- ➕ Adiciona vike e vike-react
Para encontrar o emoji do github adequado, é possível usar o site gitmoji.dev, o assistente de terminal gitmoji-cli ou ainda a extensão do VS Code Gitmoji Commit, ajustando-se à preferência do contribuidor. As três opções permitem escrever o propósito do commit e receber sugestões do emoji adequado.
Para correr a app no servidor público, é necessário ter o ficheiro .env.local com os segredos de produção. De seguida, correr
yarn buildpara compilar e construir o projeto na pasta dist/, e finalmente correr
yarn previewque irá lançar uma instância otimizada da app.
Feito com ❤️ por Francisco Sousa.