Portal do Dados Abertos de Feira

Frontend do Portal do Dados Abertos de Feira. Coleta e APIs no Maria Quitéria.

Contribuindo para o projeto

Contribuições são muito bem-vindas. Veja como contribuir no nosso Guia de Contribuição.

Toda a comunicação e demais interações do Dados Abertos de Feira estão sujeitas ao nosso Código de Conduta.

Configurando seu ambiente

Você precisará do Yarn Classic para rodar o projeto.

Instale as dependências e prepare os serviços

yarn

Após a instalação das dependências crie os arquivos com as variáveis de ambiente de acordo com os arquivos de exemplo do projeto:

.env.development # para rodar em ambiente local

Acessando o site

Rode o servidor com:

yarn dev

Acessando a versão de produção

yarn build
yarn start

Node

Para rodar o projeto na sua maquina, o projeto requer que você tenha a mesma versão do node.js que roda no ambiente de produção:

Se você precisa rodar o projeto em versões diferentes do Node.js você pode alterar para a versão requerida no package.json:

  "engines": {
    "node": "16.19.0", // versão do node requerida para rodar o projeto.
  }

A versão de produção do node.js pode ser configurada através da variável de ambiente no netlify.toml:

[build.environment]
  NODE_VERSION = "16.19.0"

⚠️ É recomendado que o ambiente de desenvolvimento contenha a mesma versão do node.js que roda em produção. Isso pode ajudar a evitar bugs que surgem devido a diferenças nas versões.

Rodando lint

yarn lint

Rodando os testes

yarn test

Se deseja rodar com coverage:

yarn test:coverage

Storybook

O Storybook é uma ferramenta que permite documentar interfaces, por enquanto, todo nosso styleguide e tarefas de front em geral poderão ser visualizadas com a ferramenta.

yarn storybook

Inicia um servidor na porta 6006, navegue até http://localhost:6006 para visualizar os componentes da interface.

Design das páginas

Os designs das páginas do projeto podem ser encontrados aqui.