Skip to content

As-Raparigas-do-Codigo/ardc-website

Repository files navigation

As Raparigas do Código

Este repositório contém o código do nosso website raparigasdocodigo.pt, e foi criado com React - Create React App.

Note for non-Portuguese Speaking Contributors

This repository contains the code for our website raparigasdocodigo.pt. This was bootstrapped with Create React App.

How to contribute

Learn how to contribute to the project by reading our contribution guidelines at CONTRIBUTING.md.

Setup and running the app

In the project directory, you can run:

Script Description
npm use Specify node version to use locally. In case you don't have the version specified, you can run nvm install <node-version>
npm install Installs dependencies necessaries to run the app.
npm start Runs the app in development mode. Open http://localhost:3000 to view it in your browser.
npm run build Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.
npm run buil:deploy-ftp Check the Deployment section
npm run lint Runs the linter.
npm run lint:fix Runs the linter and fixes the errors (If any doubts, check this site).
npm run format Runs the formatter.
npm run precommit Runs the linter, fixes the errors, and runs the formatter.
npm run configure-husky Configures husky if not yet configured in project.

Como contribuir

Percebe como podes contribuir para o projeto através das nossas diretrizes de contribuição disponíveis em CONTRIBUTING.md.

Antes de começares, lê o nosso código de conduta disponível em CODE_OF_CONDUCT.md.

Se quiseres atualizar os dados das nossas atividades ou da equipa, podes ler o guia de atualização em docs/ATUALIZACAO_DE_CONTEUDO.md.

Configuração e execução da app

No diretório do projeto, podes executar:

Comando Descrição
npm use Define a versão do Node a usar localmente. Caso não tenhas a versão especificada, podes instalar a versão com nvm install <node-version>
npm install Instala as dependências necessárias para executar a aplicação.
npm start Compila a aplicação em modo de desenvolvimento. Abre http://localhost:3000 para visualizares no teu browser.
npm run build Compila a app na pasta build. Isto integra corretamente a biblioteca React no modo de produção e otimiza a compilação para o melhor desempenho. A compilação é minificada e os nomes dos arquivos incluem os hashes.
npm run buil:deploy-ftp Verificar a secção de implementação.
npm run lint Corre o linter.
npm run lint:fix Corre o linter e corrige os erros possíveis de correção (Em caso de dúvidas, verificar neste site).
npm run format Corre o formatador em todos os arquivos.
npm run precommit Corre o linter, corrige os erros possíveis e formata o código.
npm run configure-husky Configura o husky, se não estiver configurado no projeto.

Contribuidores

Made with contrib.rocks.