adobe / adobe/aem-cloud-service-source-migration
difficult to setup the environment to run repository modernizer tool
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
### Expected Behaviour
smooth and easy simple step documentation.
### Actual Behaviour
The setup instructions were to install node and npm, but in later stages of installation like `npm install @adobe/aem-cs-source-migration-repository-modernizer` facing compatibility issues like we need to have 32bit node version.
Also it is not so clear on where to run the npm install commands, a detailed step by step documentation couldmotivate to utilize the tool.
### Reproduce Scenario (including but not limited to)
Tired to follow the read me documentation but not luck in configuring the tool.
#### Steps to Reproduce
Step 1: installed nodejs v14.16.1 and nvm v10.21.0 (in windows)
Step 2: running the `npm install @adobe/aem-cs-source-migration-repository-modernizer` command in project folder results in error in installing nan package.
#### Platform and Version
nodejs v14.16.1
nvm v10.21.0
#### Sample Code that illustrates the problem
#### Logs taken while reproducing problem
gyp info spawn args '-Goutput_dir=.' ]
gyp: Call to 'node -e "require('nan')"' returned exit status 1 while in binding.gyp. while trying to load binding.gyp
gyp ERR! configure error
gyp ERR! stack Error: `gyp` failed with exit code: 1
gyp ERR! stack at ChildProcess.onCpExit (C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\lib\configure.js:351:16)
gyp ERR! stack at ChildProcess.emit (events.js:198:13)
gyp ERR! stack at Process.ChildProcess._handle.onexit (internal/child_process.js:248:12)
gyp ERR! System Windows_NT 10.0.17763
gyp ERR! command "C:\\Program Files\\nodejs\\node.exe" "C:\\Program Files\\nodejs\\node_modules\\npm\\node_modules\\node-gyp\\bin\\node-gyp.js" "rebuild"
gyp ERR! cwd C:\~\AppData\Local\@adobe\aio-cli\node_modules\ltx\node_modules\node-expat
Contributor guide
Research direction
Start with the repository README and reproduce the reported npm install failure on Windows using the Node.js and nvm versions listed in the issue. Document where each command should run, the required compatible environment, and a complete installation path; done means a newcomer can follow the steps and install the repository modernizer successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100