feat: add cross-platform launcher scripts for easy setup#262
Open
cwjustice wants to merge 3 commits intolfnovo:mainfrom
Open
feat: add cross-platform launcher scripts for easy setup#262cwjustice wants to merge 3 commits intolfnovo:mainfrom
cwjustice wants to merge 3 commits intolfnovo:mainfrom
Conversation
Add comprehensive launcher scripts for both Unix/Linux/Mac and Windows platforms to simplify the setup and launch process for Open Notebook. Features: - Automatic dependency checking (uv, Node.js, npm, SurrealDB) - Auto-installation of missing tools where possible - .env file creation from template if missing - Frontend dependency installation - Sequential service startup with health checks - Process monitoring and graceful shutdown - Detailed status messages and colored output - Log file management Unix/Linux/Mac: - launcher.sh: Bash script with cleanup trap handling - Automatically detects ports and provides URLs - Follows services with log output - Ctrl+C cleanly shuts down all services Windows: - launcher.bat: Batch script for Windows systems - Starts services in separate minimized windows - Opens browser automatically - Provides instructions for stopping services This makes it much easier for new users to get started with Open Notebook without manually running multiple commands or understanding the full architecture.
Contributor
There was a problem hiding this comment.
2 issues found across 2 files
Prompt for AI agents (all 2 issues)
Understand the root cause of the following 2 issues and fix them.
<file name="launcher.sh">
<violation number="1" location="launcher.sh:191">
The port-detection line relies on `grep -P`, but macOS ships BSD grep without that option. On macOS this prints `grep: illegal option -- P`, so the script always falls back to 3000 even when Next.js selects a different port. Please switch to a portable pattern (e.g., grep -E + cut) so Mac users get the correct port.</violation>
</file>
<file name="launcher.bat">
<violation number="1" location="launcher.bat:110">
The SurrealDB window title doesn't match the "Open Notebook*" filter used in the provided taskkill command, so the suggested shutdown command leaves SurrealDB running.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Ask questions if you need clarification on any suggestion
Reply to cubic to teach it or ask questions. Re-run a review with @cubic-dev-ai review this PR
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Owner
|
Hey @cwjustice .. this is a great idea. But for this to fit most users, it's probably a good idea for us to foresee cases where SurreadlDB will be ran on docker. Perhaps the surrealdb stuff should be a flag or a warning? Maybe we should also integrate it with the Makefile for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add comprehensive launcher scripts for both Unix/Linux/Mac and Windows platforms to simplify the setup and launch process for Open Notebook.
Features:
Unix/Linux/Mac:
Windows:
This makes it much easier for new users to get started with Open Notebook without manually running multiple commands or understanding the full architecture.
Description
Related Issue
Fixes #
Type of Change
How Has This Been Tested?
uv run pytest)Test Details:
Design Alignment
Which design principles does this PR support? (See DESIGN_PRINCIPLES.md)
Explanation:
Checklist
Code Quality
Testing
make rufforruff check . --fixmake lintoruv run python -m mypy .Documentation
/docs(if applicable)Database Changes
/migrations)Breaking Changes
Screenshots (if applicable)
Additional Context
Pre-Submission Verification
Before submitting, please verify:
Thank you for contributing to Open Notebook! 🎉