Slove Write Installation Guide #31

[iamkanhaiyakumar]

Issue Title: Write Installation Guide

resolve issue: #31

Type of change ☑️

What sort of change have you made:

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Code style update (formatting, local variables)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [] This change requires a documentation update

Checklist: ☑️

• [] My code follows the guidelines of this project.
• [] I have performed a self-review of my own code.
• [] I have commented my code, particularly wherever it was hard to understand.
• [] I have made corresponding changes to the documentation.
• [] My changes generate no new warnings.
• [] I have added things that prove my fix is effective or that my feature works.
• [] Any dependent changes have been merged and published in downstream modules.

How Has This Been Tested? ⚙️

Describe how have you verified the changes made.

Verification of Documentation Changes in the Repository

To ensure the documentation changes in the repository are accurate and effective, the following steps were undertaken:

1. Clone the Repository

   • Cloned the updated repository containing the new documentation:

     git clone https://github.com/singodiyashubham87/Draw-it-out.git
     cd Draw-it-out

2. Review and Cross-Check Documentation

   • Carefully reviewed the new documentation against the steps outlined in the updated guide.
   • Checked for completeness, clarity, and accuracy of each step.

3. Environment Setup and Testing

   • Set up three environments: Windows, macOS, and Linux.

4. Node.js Installation Verification

   • Installed Node.js on each OS following the documented steps.
   • Confirmed successful installation using:

     node -v
     npm -v

5. Dependency Installation

   • Executed npm install in the project directory on all three environments.
   • Verified that dependencies installed without errors.

6. Application Startup

   • Started the application using npm run dev on each OS.
   • Confirmed the application was running by accessing the local server.

7. Cross-Platform Consistency Check

   • Ensured the documentation steps were consistent and accurate across Windows, macOS, and Linux.
   • Made minor adjustments for platform-specific instructions where necessary.

Summary

The verification process involved:

• Cloning the repository with updated documentation.
• Thoroughly reviewing and following the new instructions.
• Setting up Node.js, installing dependencies, and starting the application on Windows, macOS, and Linux.
• Confirming that all steps worked as described.

This process ensured that the documentation is accurate, user-friendly, and effective in helping users set up Draw-it-out on any major operating system.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
draw-it-out	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 18, 2024 6:09am
draw-it-out-zbd1	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 18, 2024 6:09am

[github-actions]

Welcome to Our repository.🎊 Thank you so much for taking the time to point this out.

[singodiyashubham87]

@iamkanhaiyakumar There is no need of the #Significance of the Changes section, Kindly remove it.

[singodiyashubham87]

Approved!

[singodiyashubham87]

@iamkanhaiyakumar Thanks for contributing to the repo. Keep up the good work :)