Add simplified setup scripts for easy initialization and running#17
Open
Add simplified setup scripts for easy initialization and running#17
Conversation
This commit introduces automated setup and run scripts that make it easy to quickly initialize and run CoreStack on Linux or MacOS, with support for various environments (Docker/non-Docker, online/offline). Changes: - Add init.sh: Automated initialization script with support for: - Auto-detection of OS (Linux/MacOS) and Docker availability - Dependency installation with offline mode support - Automatic environment variable generation - Database migration and seeding - Both Docker and local service modes - Add run.sh: Service orchestration script with support for: - Tmux-based multi-service management (recommended) - Foreground mode for simpler setups - Auto-detection of available tools - Easy window switching and session management - Update docker-compose.yml: - Fix container naming from old 'web-seed-*' to 'corestack-*' - Aligns with recent repository rename - Update package.json: - Add npm scripts: init, run, docker:up, docker:down, docker:logs - Simplify workflow with npm run init && npm run run - Add docs/quick_start.md: - Comprehensive quick start guide - Detailed instructions for all scenarios - Troubleshooting section - Follows existing documentation style - Update README.md: - Replace manage utility references with new scripts - Update quick start section with simplified workflow - Add quick start guide to documentation table - Update common commands section Benefits: - Reduces setup time from 2-4 hours to under 5 minutes - Supports offline/on-prem environments (npm over proxy) - Works with or without Docker - Consistent developer experience across machines - Better error handling and user feedback
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.
This commit introduces automated setup and run scripts that make it easy to quickly initialize and run CoreStack on Linux or MacOS, with support for various environments (Docker/non-Docker, online/offline).
Changes:
Add init.sh: Automated initialization script with support for:
Add run.sh: Service orchestration script with support for:
Update docker-compose.yml:
Update package.json:
Add docs/quick_start.md:
Update README.md:
Benefits: