docs: install from source#8369
Conversation
dosubot
Bot
added
the
size:M
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe changes update documentation to provide clearer and more detailed instructions for installing and running Langflow from source. This includes enhancements to the README, contribution guide, and installation documentation, with step-by-step setup using Make, expanded configuration options, and cross-references between relevant documentation sections. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Repository
participant Make
User->>Documentation: Reads "Install from source" instructions
User->>Repository: Clones Langflow repository
User->>Make: Runs `make init`
Make->>Make: Installs dependencies, cleans cache, builds frontend, starts app
User->>Make: (Optional) Runs `make run_cli` with custom options
Make->>Make: Starts Langflow with user-defined settings
Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/docs/Contributing/contributing-how-to-contribute.md (1)
21-29:⚠️ Potential issueMissing initial clone instruction.
The guide asks to fork and add aforkremote but never tells the user to clone the repository. Please insert a step to clone your fork or the upstream repo before adding remotes.
🧹 Nitpick comments (2)
docs/docs/Contributing/contributing-how-to-contribute.md (2)
17-20: Consider adding Python prerequisite.
The Make-based setup assumes Python is already installed (for uv). Adding* Python 3.10–3.13to prerequisites will prevent confusion.
43-50: Unify list style for bullet points.
Markdown lint prefers asterisks (*) over hyphens (-). For consistency, replace hyphens in the feature list with asterisks.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
44-44: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
45-45: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
46-46: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
47-47: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(2 hunks)docs/docs/Contributing/contributing-how-to-contribute.md(2 hunks)docs/docs/Get-Started/get-started-installation.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/Contributing/contributing-how-to-contribute.md
[uncategorized] ~61-~61: A punctuation mark might be missing here.
Context: ... | |-----------|---------|-------------| | log_level | debug | Set the loggin...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
docs/docs/Contributing/contributing-how-to-contribute.md
44-44: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
45-45: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
46-46: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (8)
docs/docs/Get-Started/get-started-installation.md (1)
68-71: Link to source installation is well placed and correct.
The new subsection cleanly references the detailed guide and uses the proper anchor.README.md (1)
20-20: Trailing whitespace removal in feature list is correct.
The formatting inconsistency has been fixed.docs/docs/Contributing/contributing-how-to-contribute.md (6)
11-14: Section introduction looks good.
The new "Install Langflow from source" section is appropriately placed and clearly titled.
31-41: Environment setup steps are clear.
Changing into the repo root and runningmake initis well documented.
51-57:make run_cliinstructions are clear.
The example command and parameter explanation are accurate and helpful.
59-67: Parameter table formatting is good.
The table clearly documentsmake run_clioptions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: A punctuation mark might be missing here.
Context: ... | |-----------|---------|-------------| |log_level|debug| Set the loggin...(AI_EN_LECTOR_MISSING_PUNCTUATION)
69-74: Pre-commit hook instructions are correct.
The optional hook setup is well explained, including the note on usinguv run git commit.
78-79:Details
✅ Verification successful
Verify Makefile targets.
Ensure that the Makefile definesunit_testsandteststargets as referenced here. You can run:to confirm.
🏁 Script executed:
grep -E "unit_tests:|tests:" MakefileLength of output: 136
Makefile targets confirmed
The Makefile defines bothunit_testsandteststargets as referenced in the docs, so no changes are needed.
- unit_tests: ## run unit tests
- tests: ## run unit, integration, coverage tests
|
Build successful! ✅ |
edwinjosechittilappilly
left a comment
edwinjosechittilappilly
left a comment
There was a problem hiding this comment.
🚀 Getting Started with Langflow
1. Prerequisites
- uv (Python package/dependency manager)
- npm (Node.js package manager)
2. Install All Dependencies
This will install both backend and frontend dependencies, build the frontend, and get everything ready:
make init3. Run the Application
To start the backend and serve the frontend:
make run_cli- This will build and serve the app at the default host/port (http://0.0.0.0:7860).
4. Common Development Commands
- Install only frontend dependencies:
make install_frontend
- Build frontend static files:
make build_frontend
- Install only backend dependencies:
make install_backend
- Run frontend in development mode (hot reload):
make frontend
- Run backend in development mode:
make backend
5. Code Quality & Testing
- Format code (backend & frontend):
make format
- Run all tests:
make tests
- Run only unit tests:
make unit_tests
- Run only integration tests:
make integration_tests
6. Clean Up
- Clean Python cache:
make clean_python_cache
- Clean npm cache and frontend build:
make clean_npm_cache
- Clean everything:
make clean_all
For more commands, run:
make helpThis will list all available Makefile targets and their descriptions.
|
@mendonk can you take a look at adding Points 4 and 5 from the above content in the docs? |
dosubot
Bot
added
size:L
github-actions
Bot
added
documentation
github-actions
Bot
added
documentation
|
Build successful! ✅ |
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
Some comments to possibly help with clarity, but nothing critical.
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
4 participants
make run_clicommand.Summary by CodeRabbit