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.

Sign up for GitHub

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

refactor: contribution guide #15

Merged
merged 1 commit into from
Aug 1, 2024
Merged

refactor: contribution guide #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 20 additions & 19 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
# Development

For now this uses a modified cli to work around issues with symlinked packages.

This is how to start the example app so you can test code with it.

```bash
# In the repo root folder.
# Install dependencies.
yarn
Make sure you are running on node 18+ and java 21
# This package Using Yarn3.6.4
corepack enable

# Link module.
yarn link

# Move to example folder.
cd ReactNativeFastImageExampleOld
# check (Should return 3.6.4)
yarn -v
# If version listed is not 3.6.4
corepack prepare yarn@3.6.4 --activate

# In the repo root folder.
# Install dependencies.
yarn

# Link module.
yarn link react-native-fast-image
# Android
yarn example android

# IOS
# Install pod dependency
cd ReactNativeFastImageExample/ios
bundle install
pod install

# Start packager.
yarn start

# Start the iOS app.
yarn react-native run-ios
# Start the android app.
yarn react-native run-android
# You will need to re-run those commands to re-compile native code.
# Got to root folder
cd ../..
yarn example ios
```
Loading