составитель карт

Чартикулятор

Charticulator — это новый инструмент построения диаграмм, который позволяет создавать диаграммы путем интерактивного указания ограничений.

Команда проекта

• Дунхао Рен
• Бонгшин Ли
• Мэтью Бремер
• Натан Эванс
• Катя Литвинец
• Дэвид Титсворт
• Крис Тревино

Строить

Для подготовки среды разработки выполните следующие шаги:

• Установите nodejs 8.0+: https://nodejs.org/
• Установите Yarnjs 1.7+: https://yarnpkg.com/

Установите модули узлов:

yarn

Скопируйте файл конфигурации шаблона и отредактируйте его содержимое:

cp config.template.yml config.yml
# (on windows, use copy instead of cp)

Запустите следующую команду для сборки Charticulator, который создаст автономный пакет в папке dist :

yarn build

Запустите локальный веб-сервер для тестирования 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_server

Разработка

Для активной среды разработки оставьте следующую команду:

yarn start

Эта команда отслеживает любые изменения в 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 со следующим содержание:

", "description": "", "tables": [ { "name": "", "type": "", "url": "" } ] } ]">

 [
    {
        "name": "",
        "description": "",
        "tables": [
            {
                "name": "",
                "type": "",
                "url": ""
            }
        ]
    }
]

Тестирование

В настоящее время в Charticulator включен элементарный тестовый код:

yarn test

Необходимо больше тестовых случаев.

Содействие

Этот проект приветствует вклад и предложения. Большинство вкладов требуют от вас согласия с Лицензионным соглашением для авторов (CLA), в котором говорится, что вы имеете право и действительно предоставляете нам права на использование вашего вклада. Подробную информацию можно найти на сайте https://cla.microsoft.com.

Когда вы отправляете запрос на включение, CLA-бот автоматически определяет, нужно ли вам предоставить CLA, и соответствующим образом оформляет PR (например, метку, комментарий). Просто следуйте инструкциям бота. Вам нужно будет сделать это только один раз во всех репозиториях, используя наш CLA.

В этом проекте принят Кодекс поведения Microsoft с открытым исходным кодом. Для получения дополнительной информации см. часто задаваемые вопросы о Кодексе поведения или свяжитесь с нами по адресу [email protected], если у вас возникнут дополнительные вопросы или комментарии.

Документация

Запустите yarn typedoc для создания страниц документации. Страница будет доступна в ./docs/charticulator

Начальной точкой документации является индексная страница {@link "index"}.