Fix issue #12: Add server run instructions and convenience launch script #13-updated#16
Open
Ashok-0167 wants to merge 4 commits intoAbishekPonmudi:mainfrom
Open
Fix issue #12: Add server run instructions and convenience launch script #13-updated#16Ashok-0167 wants to merge 4 commits intoAbishekPonmudi:mainfrom
Ashok-0167 wants to merge 4 commits intoAbishekPonmudi:mainfrom
Conversation
…unch scripts, remove unused file
Fix issue 12 server execution
|
@Ashok-0167 is attempting to deploy a commit to the abishekponmudi's projects Team on Vercel. A member of the Team first needs to authorize it. |
Yasararf
approved these changes
Oct 10, 2025
Yasararf
left a comment
Yasararf
left a comment
There was a problem hiding this comment.
This PR addresses issue #12 by adding clear server run instructions to the documentation and providing a convenience launch script to simplify starting the server. These improvements will make onboarding easier for developers and streamline the development process.
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
2 participants
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 PR resolves Issue #12, where users were unable to locate or run the Planqx Server after completing the PlanqX installation.
🧩 Changes Introduced:
Documentation Update: Added a new section — “Running the Planqx Server” — in README.md with step-by-step guidance on finding and launching the server executable.
Ease of Access: Introduced a convenience batch script, scripts/run-server.bat, allowing users to start the server with a simple double-click or through the command line.
Troubleshooting Support: Included additional notes in the README to help users diagnose issues such as missing executables, log locations, and permission-related errors (UAC issues).
🚀 Benefits:
Simplifies the post-installation process for new users.
Reduces confusion regarding the server launch procedure.
Minimizes user support requests related to server startup.
Enhances overall onboarding and usability experience.
🧪 How to Verify:
Install PlanqX using PlanqxSetup.exe.
Navigate to the default installation path:
C:\Program Files\PlanqX\Server
Launch the server using one of the following methods:
Command Line: PlanqxServer.exe
Batch Script: Double-click scripts/run-server.bat
Confirm that:
The server starts without errors.
Log files are generated correctly under the logs/ folder.
📚 Reference:
Resolves Issue #12