Brasil contra o Vírus
Rede colaborativa de combate ao COVID-19 no Brasil
🎓 Como instalar
***
**** a) Atualize o node-js. **** b) Usa Ubuntu LTS e/ou está com preguiça? yarn install --ignore-engines
- Instale as dependências do projeto
yarn install
🚀 Como começar
-
Para desenvolver:
yarn start
-
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
-
/.cache
: Diretório com arquivos de cache utilizados apenas durante o desenvolvimento. Essa pasta deve permanecer no .gitignore -
/node_modules
: Diretório com todas as dependências do projeto que são instaladas duranteyarn install
. Essa pasta deve permanecer no .gitignore -
/public
: Diretório gerado durante 2 processos com finalidades diferentes (Essa pasta deve permanecer no .gitignore):-
develop
: arquivos temporários -
build
: arquivos estáticos gerados que serão utilizados no ambiente de produção.
-
-
/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.-
/src/components
-
/src/images
-
/src/layouts
-
/src/pages
-
/src/templates
-
-
.gitignore
: Arquivo que contém a lista de todos os arquivos que não devem ser enviados ao git durante o versionamento. -
.prettierrc
: Arquivo de configuração do Prettier, ferramenta usada para manter a consistência da formatação do projeto. -
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). -
package.lock
Este arquivo é gerado automaticamente baseado nas versões das dependências dopackage.json
. (Você deve alterar esse arquivo). -
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. -
README.md
: Arquivo contendo algumas informações sobre o projeto.
💫 Deploy
O processo de deploy pode ser feito de duas maneiras:
-
Deploy automatizado utilizando os plugins do GatsbyJs. Consulte a documentação.
-
Deploy manual seguindo os passos:
- Rodar:
yarn build
- Copiar a pasta
public
gerada para o servidor