Thanks for your interest in Dify and for wanting to contribute! Before you begin, read the code of conduct and check out the existing issues. This document describes how to set up your development environment to build and test Dify.
You need to install and configure the following dependencies on your machine to build Dify:
- Git
- Docker
- Docker Compose
- Node.js v18.x (LTS)
- npm version 8.x.x or Yarn
- Python version 3.10.x
To set up a working development environment, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack.
you need to fork the repository.
Clone your GitHub forked repository:
git clone [email protected]:<github_username>/dify.git
To learn how to install the backend application, please refer to the Backend README.
To learn how to install the frontend application, please refer to the Frontend README.
Finally, you can now visit http://localhost:3000 to view the Dify in local environment.
After making your changes, open a pull request (PR). Once you submit your pull request, others from the Dify team/community will review it with you.
Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out GitHub's pull request tutorial on how to resolve merge conflicts and other issues. Once your PR has been merged, you will be proudly listed as a contributor in the contributor chart.
Stuck somewhere? Have any questions? Join the Discord Community Server. We are here to help!