docs: improve local setup experience with automated setup script #666
Conversation
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
- Create root-level setup-local.sh script that handles: - Prerequisite checks (Node.js, pnpm, Docker) - Dependency installation - Environment configuration - PostgreSQL initialization - Database migrations - Update main README with clear prerequisites, quick start, and troubleshooting - Improve Control package README with better setup instructions - Enhance control setup.sh with robust error handling and better output - Update CONTRIBUTING.md to reference new setup script - Add server setup-env.sh for environment configuration - Document all required and optional environment variables - Add comprehensive troubleshooting section This makes Echo extremely easy to run locally - users can now: 1. Clone the repo 2. Run bash scripts/setup-local.sh 3. Run pnpm dev 4. Navigate to http://localhost:3000 Addresses Merit-Systems#310 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Contributor
|
@malik672 is attempting to deploy a commit to the Merit Systems Team on Vercel. A member of the Team first needs to authorize it. |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #597
This makes Echo extremely easy to run locally - users can now: