Charticulator ist ein neues Diagrammtool, mit dem Sie Diagramme durch interaktive Angabe von Einschränkungen entwerfen können.
Donghao Ren
Bongshin Lee
Matthew Brehmer
Nathan Evans
Kate Lytvynets
David Tittsworth
Chris Trevino
Befolgen Sie die folgenden Schritte, um eine Entwicklungsumgebung vorzubereiten:
Installieren Sie nodejs 8.0+: https://nodejs.org/
Installieren Sie Yarnjs 1.7+: https://yarnpkg.com/
Knotenmodule installieren:
Garn
Kopieren Sie die Vorlagenkonfigurationsdatei und bearbeiten Sie ihren Inhalt:
cp config.template.yml config.yml# (unter Windows copy anstelle von cp verwenden)
Führen Sie den folgenden Befehl aus, um Charticulator zu erstellen, wodurch ein eigenständiges Paket im dist -Ordner erstellt wird:
Garnaufbau
Führen Sie einen lokalen Webserver aus, um Charticulator zu testen:
# Charticulator unter http://localhost:4000yarn server bereitstellen# Charticulator öffentlich unter http://0.0.0.0:4000 bereitstellen# Verwenden Sie dies, wenn Sie den Zugriff von einem anderen öffentlichen Computeryarn-Server aus ermöglichen möchten
Lassen Sie für eine Live-Entwicklungsumgebung den folgenden Befehl laufen:
Garnanfang
Dieser Befehl überwacht alle Änderungen in src/ und sass/ und kompiliert Charticulator automatisch neu. Öffnen Sie anschließend http://localhost:4000/, um Charticulator zu starten. Wenn Sie nun den Quellcode ändern, kann die App aktualisiert werden, indem Sie einfach die Browserseite aktualisieren (möglicherweise müssen Sie den Browser-Cache deaktivieren).
Im Entwicklungsmodus gibt es eine Testanwendung für UI-Komponenten, die unter http://localhost:4000/test.html aufgerufen werden kann.
Der Überwachungsmodus wird nicht aktualisiert, wenn Sie Folgendes ändern:
config.yml
THIRD_PARTY.yml
webpack.config.js
Wenn Sie diese aktualisieren, führen Sie bitte yarn build erneut durch.
Sie können benutzerdefinierte Beispieldatensätze hinzufügen, die mit Charticulator verwendet werden können. Erstellen Sie dazu einen datasets im Stammverzeichnis des Repositorys (sofern dieser nicht vorhanden ist), fügen Sie Ihre .csv (oder .tsv ) zu diesem Ordner hinzu und erstellen Sie schließlich eine files.json Datei im Ordner mit den folgenden Angaben Inhalt:
[
{
"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>"
}
]
}
]Charticulator enthält derzeit einen rudimentären Testcode:
Garntest
Weitere Testfälle sind erforderlich.
Dieses Projekt freut sich über Beiträge und Vorschläge. Für die meisten Beiträge müssen Sie einem Contributor License Agreement (CLA) zustimmen, in dem Sie erklären, dass Sie das Recht haben, uns die Rechte zur Nutzung Ihres Beitrags zu gewähren, und dies auch tatsächlich tun. Weitere Informationen finden Sie unter https://cla.microsoft.com.
Wenn Sie eine Pull-Anfrage einreichen, ermittelt ein CLA-Bot automatisch, ob Sie eine CLA bereitstellen und die PR entsprechend dekorieren müssen (z. B. Beschriftung, Kommentar). Folgen Sie einfach den Anweisungen des Bots. Sie müssen dies nur einmal für alle Repos tun, die unsere CLA verwenden.
Dieses Projekt hat den Microsoft Open Source Verhaltenskodex übernommen. Weitere Informationen finden Sie in den FAQ zum Verhaltenskodex oder wenden Sie sich bei weiteren Fragen oder Kommentaren an [email protected].
Führen Sie yarn typedoc aus, um Dokumentationsseiten zu generieren. Die Seite wird unter ./docs/charticulator verfügbar sein
Ausgangspunkt der Dokumentation ist die Indexseite {@link „index“}
