Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ Thanks for helping improve PoLo.

## Before You Start

Using `mise` is the easiest way to satisfy some of the local environment setup. Check it out here: https://mise.jdx.dev.

1. Complete the React Native environment setup for your platform:
https://reactnative.dev/docs/set-up-your-environment
2. Make sure you have:
- Node.js 20+
- Ruby 3.2.4
2. Ensure these required tools are available:
- Xcode + CocoaPods (for iOS work)
- Android Studio SDK/NDK (for Android work)
- If not using `mise`, you will have to manually manage these dependencies:
- Node.js 22
- Ruby 3.2

## Initial Setup

```bash
# Recommended:
mise install

npm install
bundle install
bundle exec pod install --project-directory=ios
Expand Down
5 changes: 4 additions & 1 deletion mise.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@

[tools]
node = "22"
ruby = "3.2"
Comment on lines +2 to +4
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Confirmed with @sd in discord that these are the versions he uses.


# Tasks useful for local development

[tasks.ios-polo]
Expand All @@ -8,4 +12,3 @@ run = "open `xcrun simctl get_app_container booted com.ham2k.polo data`/Document
[tasks.ios-files]
description = "Open the `Files` folder for the current iOS Simulator"
run = "open `xcrun simctl get_app_container booted com.apple.DocumentsApp groups |grep FileProvider.LocalStorage|sed \"s/group.com.apple.FileProvider.LocalStorage//g\"`/File\\ Provider\\ Storage"

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,6 @@
"rtree": true
},
"engines": {
"node": ">=20"
"node": "22"
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not a required change per-se, but seemed appropriate.

}
}