Charticulator é uma nova ferramenta de gráficos que permite projetar gráficos especificando restrições interativamente.
Donghao Ren
Bongshin Lee
Mateus Brehmer
Nathan Evans
Kate Lytvynets
David Tittsworth
Chris Trevino
Siga as etapas a seguir para preparar um ambiente de desenvolvimento:
Instale o nodejs 8.0+: https://nodejs.org/
Instale o Yarnjs 1.7+: https://yarnpkg.com/
Instale módulos de nó:
fio
Copie o arquivo de configuração do modelo e edite seu conteúdo:
cp config.template.yml config.yml# (no Windows, use copy em vez de cp)
Execute o seguinte comando para construir o Charticulator, que criará um pacote independente na pasta dist :
construção de fio
Execute um servidor web local para testar o Charticulator:
# Servir o Charticulator em http://localhost:4000yarn server# Servir o Charticulator publicamente em http://0.0.0.0:4000# Use isto se desejar habilitar o acesso de outro computeryarn public_server
Para um ambiente de desenvolvimento ativo, mantenha o seguinte comando em execução:
início do fio
Este comando observa qualquer alteração em src/ e sass/ e recompila o Charticulator automaticamente. Feito isso, abra http://localhost:4000/ para iniciar o Charticulator. Agora, quando você altera o código-fonte, o aplicativo pode ser atualizado simplesmente atualizando a página do navegador (pode ser necessário desativar o cache do navegador).
No modo de desenvolvimento, existe uma aplicação de teste para componentes UI, que pode ser acessada em http://localhost:4000/test.html.
O modo de observação não será atualizado quando você alterar o seguinte:
configuração.yml
THIRD_PARTY.yml
webpack.config.js
Ao atualizá-los, faça yarn build novamente.
Você pode adicionar conjuntos de dados de amostra personalizados que podem ser usados com o Charticulator. Para fazer isso, crie uma pasta datasets na raiz do repositório (se não existir), adicione seu .csv (ou .tsv ) a essa pasta e, finalmente, crie um arquivo files.json na pasta com o seguinte conteúdo:
[
{
"name": "<Your dataset display name>",
"description": "<Your dataset desription>",
"tables": [
{
"name": "<Your dataset file name without extension>",
"type": "<csv || tsv>",
"url": "<Your dataset file name with extension>"
}
]
}
]O Charticulator atualmente inclui um código de teste rudimentar:
teste de fio
Mais casos de teste são necessários.
Este projeto aceita contribuições e sugestões. A maioria das contribuições exige que você concorde com um Contrato de Licença de Colaborador (CLA), declarando que você tem o direito de nos conceder, e realmente nos concede, os direitos de uso de sua contribuição. Para obter detalhes, visite https://cla.microsoft.com.
Quando você envia uma solicitação pull, um bot CLA determinará automaticamente se você precisa fornecer um CLA e decorará o PR adequadamente (por exemplo, rótulo, comentário). Basta seguir as instruções fornecidas pelo bot. Você só precisará fazer isso uma vez em todos os repositórios usando nosso CLA.
Este projeto adotou o Código de Conduta de Código Aberto da Microsoft. Para obter mais informações, consulte as Perguntas frequentes sobre o Código de Conduta ou entre em contato com [email protected] com perguntas ou comentários adicionais.
Execute yarn typedoc para gerar páginas de documentação. A página estará disponível em ./docs/charticulator
O ponto inicial da documentação é a página de índice {@link "index"}
