Doc

Developers' Documentation

If you would like to contribute as a developer, the documentation will be of great help in order to understand the purpose of each module of the project.

Next, you will find the first steps needed to setup and run the application so you can start coding.

Installation

In order to install this project you will need node 6.x.x (latest), yarn. and git.

First clone this repo and install the dependencies:

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

Once installed, you can run the dev server as follows:

yarn start

Discussion and contributing

Feel free to make a pull request or post an issue

Code quality and documentation

We use ESLint to guarantee that the code is clean and readable. With the following command you can fix all the format errors in the code that can be automatically fixed and visualize all those that cannot be fixed by the linte.

yarn run eslint

If you make a contribution, do not forget to edit the wiki so everybody can interpret the new changes.

Next step

In the section Structure you can find out how the project is structured and which technologies are used.