Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
Production-ready platform for agentic workflow development.
Saved setup from 10 h ago
Will it work on macOS?
Also: Docs ↗ · In the browser ↗
Heads-upBuilding it yourself? It also needs Redis and 726 settings in .env (114 secret).
CONTRIBUTING.mdSo you're looking to contribute to Dify - that's awesome, we can't wait to see what you do. As a startup with limited headcount and funding, we have grand ambitions to design the most intuitive workflow for building and managing LLM applications. Any help from the community counts, truly.
We need to be nimble and ship fast given where we are, but we also want to make sure that contributors like you get as smooth an experience at contributing as possible. We've assembled this contribution guide for that purpose, aiming at getting you familiarized with the codebase & how we work with contributors, so you could quickly jump to the fun part.
This guide, like Dify itself, is a constant work in progress. We highly appreciate your understanding if at times it lags behind the actual project, and welcome any feedback for us to improve.
In terms of licensing, please take a minute to read our short License and Contributor Agreement. The community also adheres to the code of conduct.
Looking for something to tackle? Browse our good first issues and pick one to get started!
Got a cool new model runtime or tool to add? Open a PR in our plugin repo and show us what you've built.
Need to update an existing model runtime, tool, or squash some bugs? Head over to our official plugin repo and make your magic happen!
Join the fun, contribute, and let's build something awesome together! 💡✨
Don't forget to link an existing issue or open a new issue in the PR's description.
[!IMPORTANT] Please make sure to include the following information when submitting a bug report:
How we prioritize:
| Issue Type | Priority | | ------------------------------------------------------------ | --------------- | | Bugs in core functions (cloud service, cannot login, applications not working, security loopholes) | Critical | | Non-critical bugs, performance boosts | Medium Priority | | Minor fixes (typos, confusing but working UI) | Low Priority |
[!NOTE] Please make sure to include the following information when submitting a feature request:
How we prioritize:
| Feature Type | Priority | | ------------------------------------------------------------ | --------------- | | High-Priority Features as being labeled by a team member | High Priority | | Popular feature requests from our community feedback board | Medium Priority | | Non-core features and minor enhancements | Low Priority | | Valuable but not immediate | Future-Feature |
fixes #<issue_number>For setting up the frontend service, please refer to our comprehensive guide in the web/README.md file. This document provides detailed instructions to help you set up the frontend environment properly.
Testing: All React components must have comprehensive test coverage. See web/docs/test.md for the canonical frontend testing guidelines and follow every requirement described there.
For setting up the backend service, kindly refer to our detailed instructions in the api/README.md file. This document contains step-by-step guidance to help you get the backend up and running smoothly.
We recommend reviewing this document carefully before proceeding with the setup, as it contains essential information about:
Feel free to reach out if you encounter any issues during the setup process.
If you ever get stuck or get a burning question while contributing, simply shoot your queries our way via the related GitHub issue, or hop onto our Discord for a quick chat.
<br/>Before installing Dify, make sure your machine meets the following minimum system requirements:
- CPU >= 2 Core
- RAM >= 4 GiB
The easiest way to start the Dify server is through Docker Compose. Before running Dify with the following commands, make sure that Docker and Docker Compose are installed on your machine:
cd dify
cd docker
cp .env.example .env
docker compose up -d
After running, you can access the Dify dashboard in your browser at http://localhost/install and start the initialization process.
Please refer to our FAQ if you encounter problems setting up Dify. Reach out to the community and us if you are still having issues.
If you'd like to contribute to Dify or do additional development, refer to our guide to deploying from source code
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/neshpat/dify.git cd dify
Docker
brew install --cask docker # Docker Desktop
Needs: Redis (no compose file — install locally or run via Docker)
In the maintainers' order. Do the README instructions above first — they cover steps outside the terminal.
cp .env.example .env docker compose up -d
No reports for macOS yet.
GitManual AI Agent reads the 14 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.