Charticulator는 제약 조건을 대화식으로 지정하여 차트를 디자인할 수 있는 새로운 차트 작성 도구입니다.
개발 환경을 준비하려면 다음 단계를 따르세요.
노드 모듈을 설치합니다.
yarn
템플릿 구성 파일을 복사하고 내용을 편집합니다.
cp config.template.yml config.yml
# (on windows, use copy instead of cp)
dist
폴더에 자체 포함 번들을 생성하는 Charticulator를 빌드하려면 다음 명령을 실행하십시오.
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에서 액세스할 수 있는 UI 구성 요소용 테스트 애플리케이션이 있습니다.
다음을 변경하면 시계 모드가 업데이트되지 않습니다.
이를 업데이트할 때 yarn build
다시 수행하세요.
Charticulator와 함께 사용할 수 있는 사용자 정의 샘플 데이터세트를 추가할 수 있습니다. 이렇게 하려면 저장소 루트에 datasets
폴더를 만들고(없는 경우) 해당 폴더에 .csv
(또는 .tsv
)를 추가한 후 마지막으로 다음을 사용하여 폴더에 files.json
파일을 만듭니다. 내용물:
[
{
"name": "",
"description": "",
"tables": [
{
"name": "",
"type": "",
"url": ""
}
]
}
]
Charticulator에는 현재 기본적인 테스트 코드가 포함되어 있습니다.
yarn test
더 많은 테스트 케이스가 필요합니다.
이 프로젝트는 기여와 제안을 환영합니다. 대부분의 기여는 귀하가 귀하의 기여를 사용할 수 있는 권리를 갖고 있으며 실제로 그렇게 하고 있음을 선언하는 기여자 라이센스 계약(CLA)에 동의해야 합니다. 자세한 내용은 https://cla.microsoft.com을 참조하세요.
끌어오기 요청을 제출하면 CLA-bot이 자동으로 CLA를 제공해야 하는지 여부를 결정하고 PR을 적절하게 장식합니다(예: 라벨, 댓글). 봇이 제공하는 지침을 따르기만 하면 됩니다. CLA를 사용하여 모든 저장소에서 이 작업을 한 번만 수행하면 됩니다.
이 프로젝트는 Microsoft 오픈 소스 행동 강령을 채택했습니다. 자세한 내용은 행동 강령 FAQ를 참조하거나 추가 질문이나 의견이 있는 경우 [email protected]으로 문의하세요.
문서 페이지를 생성하려면 yarn typedoc
실행하세요. 해당 페이지는 ./docs/charticulator
에서 사용할 수 있습니다.
문서의 시작점은 색인 페이지입니다. {@link "index"}