Skip to content

Windows Installation Guide with Detailed Steps and Fixes#81

Merged
ersel merged 3 commits intoCyprusCodes:mainfrom
abetoluwani:main
Feb 2, 2025
Merged

Windows Installation Guide with Detailed Steps and Fixes#81
ersel merged 3 commits intoCyprusCodes:mainfrom
abetoluwani:main

Conversation

@abetoluwani
Copy link
Contributor

Description:
This pull request introduces the first official Windows installation guide, providing a detailed, step-by-step approach to setting up the necessary tools. The goal is to ensure a seamless installation process by outlining prerequisites, command-line instructions, troubleshooting steps, and visual references for common errors.

Changes Included:

  • First-time Windows documentation, covering all required tools and configurations.
  • Added a Prerequisites section to ensure users have Git installed and configured in their IDE.
  • Comprehensive NVM installation steps, including:
    • Download and setup instructions.
    • Verification commands.
    • Steps to install and use Node.js via NVM.
  • Included troubleshooting steps for npm -v errors, including execution policy fixes.
  • Detailed Docker installation guide, ensuring clarity in:
    • Installing Docker Desktop.
    • Verifying the installation.
    • Managing Docker as a non-admin user with a clear explanation of user permissions.
  • Explained Docker Compose installation and verification.
  • First-time Xest installation guide, emphasizing the need for a Git-based terminal.
  • Retained all image references to illustrate common errors users may encounter.

Screenshots & References:

  • Included images for npm -v errors.
  • Added reference to error_2.png for Docker user permission issues.

Why This Change?

  • This is the first dedicated Windows installation guide.
  • Many users face common issues while setting up NVM, Docker, and Xest.
  • The original resources lacked Windows-specific instructions, leading to confusion.
  • Adding troubleshooting steps will reduce errors and speed up setup.
  • Image references enhance clarity and provide quick visual identification of errors.

How to Test?

  1. Follow the steps in the Windows Installation Guide.
  2. Verify:
    • Git installation using git --version
    • NVM installation with nvm version
    • Node.js setup with node -v and npm -v
    • Docker installation with docker --version
    • Docker Compose verification with docker compose version
    • Xest installation with xx --version
  3. If any errors occur, check the troubleshooting steps and confirm they resolve the issues.

Additional Notes:

  • Xest requires a Git-based terminal (e.g., Git Bash, WSL) due to its reliance on grep. This is explicitly mentioned in the prerequisites.
  • Restarting the system is emphasized where necessary to apply changes correctly.

Ready for Review:

  • Please review the Windows installation guide and let me know if any further improvements are needed!

@ersel ersel merged commit 7915dae into CyprusCodes:main Feb 2, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants