Doc_es

Documentación para desarrolladores

Si deseas contribuir al desarrollo de Ediphy, la documentación te será de gran ayuda para comprender la función de cada módulo del proyecto. A continuación encontrarás los primeros pasos para instalar y arrancar la aplicación y así poder comenzar a desarrollar.

Instalación

Para instalar este proyecto necesitas node 6.x.x (latest), yarn. y git. Primero clona el repositorio y después instala las dependencias necesarias.

git clone https://github.com/ging/ediphy.git
cd ediphy
yarn 
yarn upgrade

Una vez instaladas las dependencias, podrás arrancar la aplicación de la siguiente manera:

yarn start

Discusión y contribución

Anímate a realizar un Pull Request o a enviarnos un mensaje o issue.

Calidad del código y documentación

En Ediphy empleamos ESLint para garantizar una cierta calidad en el código. Con la siguiente línea arreglarás todos los errores de formato y visualizarás aquellos que no se pueden arreglar automáticamente:

yarn run eslint

Si contribuyes no te olvides de editar la Wiki para que todo el mundo sepa interpretar los nuevos cambios.

Siguientes pasos

En la sección Estructura se explican las tecnologías empleadas en este proyecto.