I was able to get my hands on windows laptop (8GB RAM) with following configuration:
Windows 11 Version 23H2 (2024-10)
git 2.47.0.2
node 20.18 LTS
Webstorm 2024.2.4 Community Edition
Steps
clone repo - no issues
installed yarn - no issues
yarn install - no issues
yarn build - a few problems arrived
yarn test - another bunch of problems
Problems - yarn build
Rm -rf usage
It seems we use a lot of rm -rf commands to remove certain ./dist folders, but Windows does not have any equivalent for that.
Solution
Install rimraf package via yarn and update the package.json files with "rimraf ./dist" instead of "rm -rf dist"
Error: Delete 'cr' prettier/prettier
This one was connected to sdk-nextjs-integration app, it seems that on windows files in that folder have end line characters added, and eslint does not like it.
Solution
Set endOfLine to auto in .eslintrc.json in app folder:
Docs not building
Docs are using find command to filter and delete files during build, but windows does not have any equivalent for it.
Solution
None, just skipped build for docs.
**Problems - yarn test:solo"
Docker
To run this we need docker for windows. Installed version 4.34.3, but it did not want to start at all. Long story short, there is an ongoing issue with WSL (Windows Subsystem for Linux).
Solution
I did update to version 2.3.24.0, but this solution not always works for everyone.
Docker compose -f
For some reason docker did not like -f param in sdk-aws-kms-adapter start thor solo command. It did throw this error:
sdk-aws-kms-adapter:test: unknown shorthand flag: 'f' in -f
sdk-aws-kms-adapter:test: See 'docker --help'
Solution
None for now
Test passed
sdk-errors: all
sdk-logging: all
sdk-aws-kms-adapter: none
sdk-next-js-integration: all
sdk-rpc-proxy: 5/6
sdk-integration-node: all
sdk-cloudflare-integration: worker died
sdk-core: all
sdk-ethers-adapter: all
sdk-hardhat-plugin: 5/6
rest - not run
The reason why they fail is too low specced laptop as docker + windows eats tons of RAM. Most failures were connected to timeouts and some docker issues.
Description
I was able to get my hands on windows laptop (8GB RAM) with following configuration:
Steps
Problems - yarn build
Rm -rf usage It seems we use a lot of rm -rf commands to remove certain ./dist folders, but Windows does not have any equivalent for that.
Solution Install rimraf package via yarn and update the package.json files with "rimraf ./dist" instead of "rm -rf dist"
Error: Delete 'cr' prettier/prettier This one was connected to sdk-nextjs-integration app, it seems that on windows files in that folder have end line characters added, and eslint does not like it.
Solution Set endOfLine to auto in .eslintrc.json in app folder:
it skips the check - not ideal but it works.
Docs not building Docs are using find command to filter and delete files during build, but windows does not have any equivalent for it.
Solution None, just skipped build for docs.
**Problems - yarn test:solo"
Docker To run this we need docker for windows. Installed version 4.34.3, but it did not want to start at all. Long story short, there is an ongoing issue with WSL (Windows Subsystem for Linux).
Solution I did update to version 2.3.24.0, but this solution not always works for everyone.
Docker compose -f For some reason docker did not like -f param in sdk-aws-kms-adapter start thor solo command. It did throw this error:
Solution None for now
Test passed
The reason why they fail is too low specced laptop as docker + windows eats tons of RAM. Most failures were connected to timeouts and some docker issues.