chore: move gnoboard in example/js/expo and simplify the root Makefile (#178)

Gnoboard uses Expo in its dependencies, so we decided to move it in the
`example/js/expo` folder.

The Makefile in the root directory had some rules that compiled the
`node_modules` and the `xcworkspace` for Gnoboard, so I removed them to
be consistent (that was the only example app that had rules in the root
Makefile).

---------

Signed-off-by: D4ryl00 <[email protected]>

Author: D4ryl00

Makefile

@@ -12,11 +12,9 @@ APP_NAME ?= gnoboard
 # Define the directory that contains the current Makefile
 make_dir := $(realpath $(dir $(abspath $(lastword $(MAKEFILE_LIST)))))
 cache_dir := $(make_dir)/.cache
-gnoboard_dir := $(make_dir)/examples/js/react-native/gnoboard
 expo_dir := $(make_dir)/expo
 
 # Argument Defaults
-APP_OUTPUT_DIR ?= $(make_dir)/examples/js/react-native/$(APP_NAME)
 IOS_OUTPUT_FRAMEWORK_DIR ?= framework/ios
 ANDROID_OUTPUT_LIBS_DIR ?= framework/android
 GO_BIND_BIN_DIR ?= $(cache_dir)/bind
@@ -44,20 +42,8 @@ PATH := $(GO_BIND_BIN_DIR):$(PATH)
 
 # * Main commands
 
-# `all` and `build` command builds everything (generate, build.ios, build.android)
-all build: generate build.ios build.android
-
-# Build iOS framework
-build.ios: generate framework.ios
-ifeq ($(OS),Darwin)
-	@echo "generate iOS framework"
-	cd $(APP_OUTPUT_DIR); $(MAKE) node_modules
-	cd $(APP_OUTPUT_DIR); $(MAKE) ios/$(APP_NAME).xcworkspace TEMPLATE_PROJECT=$(APP_NAME)
-endif
-
-# Build Android aar & jar
-build.android: generate framework.android
-	cd $(APP_OUTPUT_DIR); $(MAKE) node_modules
+# `all` and `build` command build the Go Framework
+all build: framework
 
 # Generate API from protofiles
 generate: api.generate
@@ -66,14 +52,10 @@ generate: api.generate
 regenerate: api.clean api.generate
 
 # Clean all generated files
-clean: bind.clean
-
-# Force clean (clean and remove node_modules)
-fclean:
-	cd $(APP_OUTPUT_DIR); ls; rm -rf node_modules
+clean: framework.clean
 	rm -rf $(cache_dir)
 
-.PHONY: generate regenerate build.ios build.android clean fclean
+.PHONY: generate regenerate clean
 
 # - API : Handle API generation and cleaning
 
@@ -82,8 +64,8 @@ api.clean: _api.clean.protocol _api.clean.modules
 
 # - API - rpc
 
-protos_src := $(wildcard service/rpc/*.proto)
-gen_src := $(protos_src) Makefile buf.gen.yaml $(wildcard service/gnonativetypes/*.go)
+protos_src := $(wildcard api/*.proto)
+gen_src := $(protos_src) Makefile buf.gen.yaml $(wildcard api/gnonativetypes/*.go)
 gen_sum := gen.sum
 
 _api.generate.protocol: $(gen_sum)
@@ -104,7 +86,9 @@ $(gen_sum): $(gen_src)
 		go mod tidy \
 	)
 
-_api.generate.modules:
+_api.generate.modules: api/package-lock.json
+
+api/package-lock.json:
 	$(call check-program, npm)
 	cd api; npm install
 
@@ -140,6 +124,7 @@ framework.ios: $(gnocore_xcframework)
 .PHONY: framework.ios
 
 $(gnocore_xcframework): $(bind_init_files) $(go_deps)
+	$(MAKE) generate
 ifeq ($(OS),Darwin)
 	@mkdir -p $(dir $@)
 	# need to use `nowatchdog` tags, see https://github.com/libp2p/go-libp2p-connmgr/issues/98
@@ -157,6 +142,7 @@ framework.android: $(gnocore_aar) $(gnocore_jar)
 .PHONY: framework.android
 
 $(gnocore_aar): $(bind_init_files) $(go_deps)
+	$(MAKE) generate
 	@mkdir -p $(dir $@) .cache/bind/android
 	$(gomobile) bind -v \
 		-cache $(cache_dir)/android-gnonative \
@@ -165,10 +151,11 @@ $(gnocore_aar): $(bind_init_files) $(go_deps)
 _bind.clean.android:
 	rm -rf $(gnocore_jar) $(gnocore_aar)
 
+# - Bind
+framework: framework.ios framework.android
+.PHONY: framework
 
-# - Bind - cleaning
-
-bind.clean: _bind.clean.ios _bind.clean.android
+framework.clean: _bind.clean.ios _bind.clean.android
 	rm -rf $(bind_init_files)
 
 # - asdf
@@ -213,7 +200,7 @@ new-expo-app:
 	@echo "Installing npm dependencies"
 	cd $(OUTPUT_DIR)/$(APP_NAME) && npm install ${npm_basic_dependencies}
 
-# copy js files from gnoboard to the new app
+# copy js files from the Expo example app to the new app
 copy-js-files:
 	@echo "Copying js files"
 	@cp $(expo_dir)/example/App.tsx $(OUTPUT_DIR)/$(APP_NAME)/App.tsx

README.md

@@ -9,15 +9,29 @@ These API calls are a programming language-independent wrapper on top of the cor
 
 Watch [this Gno Native Kit tutorial](https://www.youtube.com/watch?v=N1HLyQDHGQ0) to easily get started on building and bringing your (d)apps to mobile and desktop.
 
-## Build instructions
+## Expo module
 
-### Install prerequisites for macOS 13
+To use Gno Native Kit, we advise you to use the Expo module in your Expo React-Native project. Please read the [README](expo/README.md) in the `expo` folder.
 
-(If you are on Ubuntu, see the next section to install prerequisites.)
+In the `expo/example` folder, you can find a minimal app using the Expo module.
+
+Other examples are available in the `example/js/expo` folder.
+
+## Bare React-Native project
+
+If you are interested in using Gno Native Kit in a bare React-Native project, please check the `hello` example app in the `example/js/react-native/hello` folder.
+
+## Prerequisites for building Gno Native Kit or example apps
+
+### Install requirements for macOS 13 and macOS 14
+
+(If you are on Ubuntu, see the next section to install requirements.)
 
 Install Xcode. To install the Command Line Developer Tools, in a terminal enter:
 
-    xcode-select --install
+```sh
+xcode-select --install
+```
 
 After the Developer Tools are installed, we need to make sure it is updated. In
 System Preferences, click Software Update and update it if needed.
@@ -26,50 +40,69 @@ To install asdf using brew, follow instructions at https://asdf-vm.com . In shor
 first install brew following the instructions at https://brew.sh . Then, in
 a terminal enter:
 
-    brew install asdf gnu-tar gpg jq
+```sh
+brew install asdf gnu-tar gpg
+```
 
 If your terminal is zsh, enter:
 
-    echo -e "\n. $(brew --prefix asdf)/libexec/asdf.sh" >> ${ZDOTDIR:-~}/.zshrc
+```sh
+echo -e "\n. $(brew --prefix asdf)/libexec/asdf.sh" >> ${ZDOTDIR:-~}/.zshrc
+```
 
 If your terminal is bash, enter:
 
-    echo -e "\n. \"$(brew --prefix asdf)/libexec/asdf.sh\"" >> ~/.bash_profile
+```sh
+echo -e "\n. \"$(brew --prefix asdf)/libexec/asdf.sh\"" >> ~/.bash_profile
+```
 
-Start a new terminal to get the changes to the environment.
+Start a new terminal to get the changes to the environment .
 
 (optional) To install Android Studio, download and install the latest
 android-studio-{version}-mac.dmg from https://developer.android.com/studio .
 (Tested with Jellyfish 2023.3.1 .)
 
-### Install prerequisites for Ubuntu 20.04, 22.04 and 24.04
+### Install requirements for Ubuntu 20.04, 22.04 and 24.04
 
 To install asdf, follow instructions at https://asdf-vm.com . In short, in
 a terminal enter:
 
-    sudo apt install curl git make
-    git clone https://github.com/asdf-vm/asdf.git ~/.asdf
-    echo '. "$HOME/.asdf/asdf.sh"' >> ~/.profile
-    source ~/.profile
+```sh
+sudo apt install curl git make
+git clone https://github.com/asdf-vm/asdf.git ~/.asdf
+echo '. "$HOME/.asdf/asdf.sh"' >> ~/.bashrc
+echo 'export ANDROID_HOME="$HOME/Android/Sdk"' >> ~/.bashrc
+echo 'export ANDROID_NDK_HOME="$ANDROID_HOME/ndk/23.1.7779620"' >> ~/.bashrc
+```
 
-Start a new terminal to get the changes to the environment.
+Start a new terminal to get the changes to the environment .
 
-(optional) To install Android Studio, download the latest
+To install Android Studio, download the latest
 android-studio-{version}-linux.tar.gz from
 https://developer.android.com/studio . (Tested with Jellyfish 2023.3.1 .)
 In a terminal, enter the following with the correct {version}:
 
-    sudo tar -C /usr/local -xzf android-studio-{version}-linux.tar.gz
+```sh
+sudo tar -C /usr/local -xzf android-studio-{version}-linux.tar.gz
+```
 
 To launch Android Studio, in a terminal enter:
 
-    /usr/local/android-studio/bin/studio.sh &
+```sh
+/usr/local/android-studio/bin/studio.sh &
+```
+
+### Install the tools with asdf (only need to do once)
+
+```sh
+make asdf.install_tools
+```
 
-### Get a copy of the repo
+On macOS, if you get an error like "https://github.com/CocoaPods/CLAide.git (at master@97b765e) is not yet checked out" then reinstall cocoapods like this:
 
-```console
-git clone https://github.com/gnolang/gnonative
-cd gnonative
+```sh
+asdf uninstall cocoapods
+make asdf.install_tools
 ```
 
 ### Build for Android
@@ -82,102 +115,3 @@ cd gnonative
 -   In the "SDK Tools" tab, click "Show Package Details". Expand
     "NDK (Side by side)" and check "23.1.7779620".
 -   Click OK to install and close the SDK Manager.
-
-#### Install the tools with asdf (only need to do once)
-
-(If not building for iOS, edit the file `.tool-versions` and remove the unneeded lines for `ruby` and `cocoapods`.)
-
-```console
-make asdf.install_tools
-```
-
-#### Build the Go code as a library
-
-```console
-make build.android
-```
-
-#### Start metro
-
-```console
-cd examples/js/react-native/gnoboard
-npm start
-```
-
-#### Connect your Android phone/emulator and bind its port to metro
-
-You can either connect an Android phone via USB cable, or launch an emulator device from Android Studio.
-
-##### Real device
-
-Connect your device and bind the port to metro:
-
-```console
-cd examples/js/react-native/gnoboard
-make android.reverse_tcp
-```
-
-##### Emulator device
-
-You can either run Android Studio and open the Android project in `examples/js/react-native/gnoboard/android`.
-If you prefer the CLI option:
-
-```console
-android-studio ./android
-```
-
-Once done, bind the port to metro:
-
-```console
-make android.reverse_tcp
-```
-
-#### Build with Android Studio
-
-Open Android Studio and open the current Android project if it's not already done.
-Select the right device in the device list. Open the `Run` menu, and select `Run app`.
-See more: https://developer.android.com/studio/run#basic-build-run
-
-### Build for iOS
-
-#### Install the tools with asdf (only need to do once)
-
-```console
-make asdf.install_tools
-```
-
-If you get an error like "https://github.com/CocoaPods/CLAide.git (at master@97b765e) is not yet checked out" then reinstall cocoapods like this:
-
-```console
-asdf uninstall cocoapods
-make asdf.install_tools
-```
-
-#### Build the Go code as a library
-
-```console
-make build.ios
-```
-
-#### Start metro
-
-```console
-cd examples/js/react-native/gnoboard
-npm start
-```
-
-#### Open Xcode and connect your iOS device
-
-Open Xcode and open the GnoBoard Xcode workspace: `examples/js/react-native/gnoboard/ios/gnoboard.xcworkspace`
-You can either connect an iOS phone via USB cable, or launch an emulator device from Xcode.
-See more: https://developer.apple.com/documentation/xcode/running-your-app-in-simulator-or-on-a-device
-
-#### Select a developer certificate
-
-In Xcode, double click on gnoboard project on the left pane, go to the `Signing & Capabilities` pane.
-In the `Signing` section, select your `team` certificate.
-
-#### Build with Xcode
-
-Select the right device in the device list. Open the `Product` menu, and select `Run`.
-See more: https://developer.apple.com/documentation/xcode/building-and-running-an-app