Charticulator — это новый инструмент построения диаграмм, который позволяет создавать диаграммы путем интерактивного указания ограничений.
Дунхао Рен
Бонгшин Ли
Мэтью Бремер
Натан Эванс
Катя Литвинец
Дэвид Титсворт
Крис Тревино
Для подготовки среды разработки выполните следующие шаги:
Установите nodejs 8.0+: https://nodejs.org/
Установите Yarnjs 1.7+: https://yarnpkg.com/
Установите модули узлов:
пряжа
Скопируйте файл конфигурации шаблона и отредактируйте его содержимое:
cp config.template.yml config.yml# (в Windows используйте копию вместо cp)
Запустите следующую команду для сборки Charticulator, который создаст автономный пакет в папке dist :
сборка пряжи
Запустите локальный веб-сервер для тестирования Charticulator:
# Обслуживание Charticulator по адресу http://localhost:4000yarn server# Публичное обслуживание Charticulator по адресу http://0.0.0.0:4000# Используйте это, если вы хотите разрешить доступ с другого компьютера, Yarn public_server
Для активной среды разработки оставьте следующую команду:
начало пряжи
Эта команда отслеживает любые изменения в src/ и sass/ и автоматически перекомпилирует Charticulator. После этого откройте http://localhost:4000/, чтобы запустить Charticulator. Теперь при изменении исходного кода приложение можно обновить, просто обновив страницу браузера (возможно, вам придется отключить кеш браузера).
В режиме разработки находится тестовое приложение для компонентов пользовательского интерфейса, доступ к которому можно получить по адресу http://localhost:4000/test.html.
Режим просмотра не будет обновляться, если вы измените следующее:
config.yml
THIRD_PARTY.yml
вебпак.config.js
Когда вы их обновите, повторите yarn build .
Вы можете добавить собственные образцы наборов данных, которые можно использовать с Charticulator. Для этого создайте папку datasets в корне репозитория (если она не существует), добавьте свой .csv (или .tsv ) в эту папку и, наконец, создайте в ней файл files.json со следующим содержание:
[
{
"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 включен элементарный тестовый код:
тест пряжи
Необходимо больше тестовых случаев.
Этот проект приветствует вклад и предложения. Большинство вкладов требует от вас согласия с Лицензионным соглашением для авторов (CLA), в котором говорится, что вы имеете право и действительно предоставляете нам права на использование вашего вклада. Подробную информацию можно найти на сайте https://cla.microsoft.com.
Когда вы отправляете запрос на включение, CLA-бот автоматически определяет, нужно ли вам предоставить CLA, и соответствующим образом оформляет PR (например, метку, комментарий). Просто следуйте инструкциям бота. Вам нужно будет сделать это только один раз во всех репозиториях, используя наш CLA.
В этом проекте принят Кодекс поведения Microsoft с открытым исходным кодом. Для получения дополнительной информации см. Часто задаваемые вопросы о Кодексе поведения или свяжитесь с нами по адресу [email protected], если у вас возникнут дополнительные вопросы или комментарии.
Запустите yarn typedoc для создания страниц документации. Страница будет доступна в ./docs/charticulator
Начальной точкой документации является индексная страница {@link "index"}.
