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. For instructions, please refer to the page for your preferred platform:
- Setting up Habitica Locally on Linux
- Setting up Habitica Locally on MacOS
- Setting up Habitica Locally on Windows
- Setting up Habitica Locally on Docker - this allows an installation to be run on any platform that supports Docker.
Vagrant[]
Installing Habitica using Vagrant is no longer supported. There were Vagrant installation files in the Habitica repository but they had not been updated to use the latest software that Habitica relies on and so they were deleted in the "Remove Vagrant" pull request. If you would like to refer to the previous version of this page that contained information about Vagrant, it is available in this page history entry.
Mobile Apps[]
For information about installing the code for the mobile apps refer to the GitHub repositories:
Self-Hosting an Instance[]
The instructions above describe the development setup and are not suited well in case that you would want to host your own instance of Habitica. A better approach would be to do a release build of the server and client components and deploy then only the release artifacts instead of the development runner. Unfortunately, the release build process documentation of Habitica is not publicly available. However, there are two projects on Github, that can help for self-hosting of a Habitica instance:
- https://github.com/headcounter/shabitica (for hosting on NixOS, but not updated for multiple years, unfortunately)
- https://github.com/awinterstein/habitica (automatically creates Docker containers for each Habitica release)