Template:Blacksmiths Setting up Locally: prep and git

The first step to contributing code to Habitica's habitica.com website is setting up a local instance of the website to test your changes. This page contains instructions for how to do that in . If you are using a different operating system (or a virtual machine hosted on but containing a different operating system), please refer to Setting up Habitica Locally. This page is not relevant for contributing to development for the mobile apps.

'''Read each section on this page in order, ensuring that every instruction is followed before moving on to the next. If you experience errors, always stop and solve them before moving on to the next step.'''

It is important to also read Guidance for Blacksmiths for background information about coding for Habitica.

Prepare for Troubleshooting
A local install does not always go smoothly but we will be happy to help you! Habitica uses a lot of software and we understand that it can be complicated to install it all until you are used to it. Please follow all the steps in this section before you experience errors so that, if necessary, you can ask for help easily and we can assess your problem rapidly.

As you are installing Habitica:


 * Record every command that you type and the full output of every command - save all the commands and outputs into text file(s) in case we need to see them later.
 * Carefully read all output messages to look for errors.
 * If you see an error, do not proceed further until the error has been resolved because later steps are likely to not work correctly.
 * If you need to deviate from any instructions anywhere on this page, record what you have done that is different and why. If you later need assistance, it is vital that the people helping you know about those differences, otherwise time can be spent on advice that isn't relevant to you.

If you need help with fixing any errors, upload all of the information you have gathered so far onto a site such as GitHub Gist, then log an issue in GitHub and tell us:
 * you are using
 * any deviations you needed to make from the standard instructions
 * any other information the instructions on this page asked you to record
 * links to your uploaded file(s)
 * what problem you're experiencing

Install Git
Create a GitHub account if you don't already have one.

Install  on your machine (installation instructions available here).