Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Installation Guide Needs Update - Node Version & Setup Instructions #6313

Open
forever8896 opened this issue Dec 10, 2024 · 0 comments

Comments

@forever8896
Copy link

Current State

The README installation guide appears to be outdated in several aspects:

  1. Node Version Mismatch

    • README recommends Node.js 16 (line 19 in README.md)
    • Package.json specifies Node.js 18:
  2. Installation Issues Across Platforms
    I've attempted installation on both Windows (WSL) and MacOS environments, following the current README instructions, and encountered several issues:

  • Windows/WSL: Missing CustomNetworkActivity Kotlin file
  • MacOS: Metro bundler errors related to transformFile undefined
  • Both platforms were verified with React Native doctor for proper configuration

Impact

These discrepancies and outdated instructions create barriers for new contributors wanting to participate in Rainbow's development.

Suggested Updates Needed

  1. Update Node.js version requirements in README to match package.json
  2. Add platform-specific troubleshooting sections
  3. Review and update the installation steps for current dependencies
  4. Consider adding a development environment verification step

Questions

  1. What is the currently recommended development environment setup?
  2. Are there any known platform-specific requirements not mentioned in the docs?

Additional Context

  • Latest repository updates were as recent as yesterday
  • Current README appears to be from last year
  • Successfully built on MacOS but encountered runtime errors
  • All standard cleanup procedures attempted (cache clearing, reinstalling dependencies, etc.)

Would love to contribute to this amazing wallet system, but first we need to ensure the path to contribution is clear and up-to-date. Happy to help test any documentation updates across different platforms.

Environment Details

  • Node version: 18.x
  • Yarn version: 4.2.2 (as specified in package.json)
  • MacOS/Windows WSL
  • React Native environment verified with doctor

Let me know if you need any additional information or clarification!

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

No branches or pull requests

1 participant