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

Updated build requirements documentation #916

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

arky
Copy link
Contributor

@arky arky commented Jan 25, 2022

Updated basic requirements in contribution document. 

@arky
Copy link
Contributor Author

arky commented Jan 25, 2022

@achou11 Please kindly review this simple PR

@arky arky closed this Jan 25, 2022
@arky arky reopened this Jan 25, 2022

* A OSX, gnu/Linux, Windows OS (64bit) computer with plenty of disk space and multi-core CPU for faster builds.
* Node 12 (<=12.16.3)
* NPM (Node Package Manager) or Yarn
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wondering if it's worth mentioning the versions of npm and yarn here. For npm, I know that Node@12 comes with npm@6 by default (latest stable is 8 – not even sure if it's compatible with Node@12). Haven't tried using yarn in this repo but my guess is that only yarn 1 will work

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will need to check with @gmaclennan Last year we did transition from npm to yarn workspaces.


### Build Requirements

For many development tasks you will also need the Android SDK installed to build Node.js for Android.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may be worth highlighting that some of these tools overlap with the react native setup (https://reactnative.dev/docs/0.66/environment-setup)

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Andrew Chou <[email protected]>
@arky
Copy link
Contributor Author

arky commented Jan 28, 2022

On-Hold till EAS build stuff lands.
https://github.com/digidem/mapeo-mobile/pull/739/files

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