Charticulator est un nouvel outil de création de graphiques qui vous permet de concevoir des graphiques en spécifiant des contraintes de manière interactive.
Suivez les étapes suivantes pour préparer un environnement de développement :
Installez les modules de nœud :
yarnCopiez le fichier de configuration du modèle et modifiez son contenu :
cp config.template.yml config.yml
# (on windows, use copy instead of cp) Exécutez la commande suivante pour créer Charticulator, qui créera un bundle autonome dans le dossier dist :
yarn buildExécutez un serveur Web local pour tester Charticulator :
# Serve Charticulator at http://localhost:4000
yarn server
# Serve Charticulator publicly at http://0.0.0.0:4000
# Use this if you want to enable access from another computer
yarn public_serverPour un environnement de développement en direct, continuez à exécuter la commande suivante :
yarn start Cette commande surveille tout changement dans src/ et sass/ et recompile automatiquement Charticulator. Une fois cela fait, ouvrez http://localhost:4000/ pour lancer Charticulator. Désormais, lorsque vous modifiez le code source, l'application peut être mise à jour en actualisant simplement la page du navigateur (vous devrez peut-être désactiver le cache du navigateur).
En mode développement, il existe une application de test pour les composants de l'interface utilisateur, accessible à l'adresse http://localhost:4000/test.html.
Le mode montre ne sera pas mis à jour lorsque vous modifierez les éléments suivants :
Lorsque vous les mettez à jour, veuillez yarn build .
Vous pouvez ajouter des exemples d'ensembles de données personnalisés pouvant être utilisés avec Charticulator. Pour ce faire, créez un dossier datasets à la racine du référentiel (s'il n'existe pas), ajoutez votre .csv (ou .tsv ) à ce dossier, et enfin créez un fichier files.json dans le dossier avec ce qui suit contenu:
[
{
"name": "",
"description": "",
"tables": [
{
"name": "",
"type": "",
"url": ""
}
]
}
]
Charticulator inclut actuellement un code de test rudimentaire :
yarn testD'autres cas de test sont nécessaires.
Ce projet accueille les contributions et suggestions. La plupart des contributions nécessitent que vous acceptiez un contrat de licence de contributeur (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez effectivement, le droit d'utiliser votre contribution. Pour plus de détails, visitez https://cla.microsoft.com.
Lorsque vous soumettez une pull request, un robot CLA déterminera automatiquement si vous devez fournir un CLA et décorera le PR de manière appropriée (par exemple, étiquette, commentaire). Suivez simplement les instructions fournies par le bot. Vous n’aurez besoin de le faire qu’une seule fois pour tous les dépôts utilisant notre CLA.
Ce projet a adopté le code de conduite Microsoft Open Source. Pour plus d’informations, consultez la FAQ sur le code de conduite ou contactez [email protected] pour toute question ou commentaire supplémentaire.
Exécutez yarn typedoc pour générer des pages de documentation. La page sera disponible dans ./docs/charticulator
Le point de départ de la documentation est la page d'index {@link "index"}
