Tutorial preparing to work with github

From Let's Control It
Revision as of 17:14, 2 March 2017 by Psy0rz (talk | contribs)
Jump to navigation Jump to search

In order to work with git and github, you'll need some one time preparation.

This may seem a bit of work, but it makes contributing to ESPEasy much easier for everyone.

Creating a github.com account

If you dont have a github account yet, create one for free here: https://github.com/join?source=hero-opensource

  • Choose the “Unlimited public repositories for free” option.
  • Go to your email and click the verify link.

Forking the ESPEasy repository

To be able to make changes and share them with us, you will need to fork our repository one time.

  • Login to your github.com with your account.
  • Go the the letscontrol ESPEasy repository, via https://github.com/letscontrolit/ESPEasy
  • Make sure you're in the correct repository and click the fork button in the upper right corner:

Espeasy fork button.png


Now you have forked the ESPEasy repository to your own account:

Espeasy own fork.png


Now you can start making improvements or fixes and send them to us via a pull request. (more on that later)


Download Github deskapp: Start the installer and click thourgh it:

Desktop will start automaticly with the welcome screen:


Signup for a github account if you dont have one yet, and login to the Github Deskapp:

The configure step is usually ok:

Skip the Repositories step:

Now you can clone your forked repository to your local computer.

In GitHub deskapp Click the + in the upper left corner Click the Clone tab Select the ESPEasy repository Click Clone ESPEasy: Select a play where you want to store the ESPEasy sourcecode.


Now you’re ready to work with git. We will explain that in the next tutorial.