ocordeiro / brcontraovirus.github.io

Site da Rede Brasil Contra o Virús

Brasil contra o Vírus

Rede colaborativa de combate ao COVID-19 no Brasil

🎓 Como instalar

1. Instale as ferramentas na sua máquina

   1. NPM
   2. YARN

*** 🪲 Deu erro, jão? yarn install v1.22.4 [1/4] Resolving packages... [2/4] Fetching packages... error @typescript-eslint/eslint-plugin@2.28.0: The engine "node" is incompatible with this module. Expected version "^8.10.0 || ^10.13.0 || >=11.10.1". Got "11.2.0" error Found incompatible module.

**** a) Atualize o node-js. **** b) Usa Ubuntu LTS e/ou está com preguiça? yarn install --ignore-engines

2. Instale as dependências do projeto

   yarn install

🚀 Como começar

1. Para desenvolver:

   yarn start

2. Agora só abrir o código e começar a editar!

   O projeto estará rodando em http://localhost:3000!

🧐 O que temos no projeto?

Um resumo da estrutura do projeto.

.
├── .cache
├── node_modules
├── public
├── src
├──── components
├──── images
├──── layouts
├──── pages
├──── templates
├── .editorconfig
├── .eslint
├── .gitignore
├── .prettierignore
├── .prettierrc
├── gatsby-config.js
├── jsconfig.js
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

1. /.cache: Diretório com arquivos de cache utilizados apenas durante o desenvolvimento. Essa pasta deve permanecer no .gitignore

2. /node_modules: Diretório com todas as dependências do projeto que são instaladas durante yarn install. Essa pasta deve permanecer no .gitignore

3. /public: Diretório gerado durante 2 processos com finalidades diferentes (Essa pasta deve permanecer no .gitignore):

   1. develop: arquivos temporários

   2. build: arquivos estáticos gerados que serão utilizados no ambiente de produção.

4. /src: Nessa pastas temos todos os arquivos e códigos que são usados para desenvolvimento do site e onde faremos todas as alterações.

   1. /src/components

   2. /src/images

   3. /src/layouts

   4. /src/pages

   5. /src/templates

5. .gitignore: Arquivo que contém a lista de todos os arquivos que não devem ser enviados ao git durante o versionamento.

6. .prettierrc: Arquivo de configuração do Prettier, ferramenta usada para manter a consistência da formatação do projeto.

7. gatsby-config.js: Arquivo com todas as configurações usadas pelo GatsbyJs, ferramenta utilizada para gerar arquivos estáticos, gerenciar imagens . É neste arquivo que colocamos configurações dos plugins utilizados e etc. (Veja a documentação das configurações para mais informações).

8. package.lock Este arquivo é gerado automaticamente baseado nas versões das dependências do package.json. (Você deve alterar esse arquivo).

9. package.json: Arquivo utilizado em projetos Node.js, onde armazenamos informações do projeto, as dependências a serem instaladas para o ambiente de produção e desenvolvimento, os scripts a serem rodados e etc.

10. README.md: Arquivo contendo algumas informações sobre o projeto.

💫 Deploy

O processo de deploy pode ser feito de duas maneiras:

1. Deploy automatizado utilizando os plugins do GatsbyJs. Consulte a documentação.

2. Deploy manual seguindo os passos:

   1. Rodar:

   yarn build

   2. Copiar a pasta public gerada para o servidor