carticulador

Cararticulador

Charticulator es una nueva herramienta de gráficos que le permite diseñar gráficos especificando restricciones de forma interactiva.

Equipo de proyecto

• Donghao Ren
• Bongshin Lee
• Mateo Brehmer
• Natalia Evans
• Kate Lytvynets
• David Tittsworth
• Chris Treviño

Construir

Siga los siguientes pasos para preparar un entorno de desarrollo:

• Instale nodejs 8.0+: https://nodejs.org/
• Instale Yarnjs 1.7+: https://yarnpkg.com/

Instalar módulos de nodo:

yarn

Copie el archivo de configuración de la plantilla y edite su contenido:

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

Ejecute el siguiente comando para compilar Charticulator, que creará un paquete autónomo en la carpeta dist :

yarn build

Ejecute un servidor web local para probar 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

Desarrollo

Para un entorno de desarrollo en vivo, mantenga ejecutado el siguiente comando:

yarn start

Este comando observa cualquier cambio en src/ y sass/ y vuelve a compilar Charticulator automáticamente. Una vez hecho esto, abra http://localhost:4000/ para iniciar Charticulator. Ahora, cuando cambia el código fuente, la aplicación se puede actualizar simplemente actualizando la página del navegador (es posible que deba desactivar la memoria caché del navegador).

En el modo de desarrollo, hay una aplicación de prueba para los componentes de la interfaz de usuario, a la que se puede acceder en http://localhost:4000/test.html.

El modo de reloj no se actualizará cuando cambies lo siguiente:

• configuración.yml
• TERCERO_PARTY.yml
• paquete web.config.js

Cuando los actualice, vuelva a yarn build .

Conjuntos de datos de muestra

Puede agregar conjuntos de datos de muestra personalizados que se pueden usar con Charticulator. Para hacerlo, cree una carpeta datasets en la raíz del repositorio (si no existe), agregue su .csv (o .tsv ) a esa carpeta y finalmente cree un archivo files.json en la carpeta con lo siguiente contenido:

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

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

Pruebas

Charticulator actualmente incluye un código de prueba rudimentario:

yarn test

Se necesitan más casos de prueba.

Contribuyendo

Este proyecto agradece contribuciones y sugerencias. La mayoría de las contribuciones requieren que usted acepte un Acuerdo de licencia de colaborador (CLA) que declara que tiene derecho a otorgarnos, y de hecho lo hace, los derechos para usar su contribución. Para obtener más detalles, visite https://cla.microsoft.com.

Cuando envía una solicitud de extracción, un CLA-bot determinará automáticamente si necesita proporcionar un CLA y decorar el PR de manera adecuada (por ejemplo, etiqueta, comentario). Simplemente siga las instrucciones proporcionadas por el bot. Solo necesitarás hacer esto una vez en todos los repositorios que utilicen nuestro CLA.

Este proyecto ha adoptado el Código de conducta de código abierto de Microsoft. Para obtener más información, consulte las preguntas frecuentes sobre el Código de conducta o comuníquese con [email protected] si tiene alguna pregunta o comentario adicional.

Documentación

Ejecute yarn typedoc para generar páginas de documentación. La página estará disponible en ./docs/charticulator

El punto de inicio de la documentación es la página de índice {@link "index"}