Seek is an app for identifying plants and animals. It is available on iOS and Android.
- Make sure you're running the Node version specified in
.nvmrc
. Realm only works with certain versions of Node, so you will need this for local data storage. - Install dependences with
npm install
- If building for iOS, run
pod install
from within theios
directory.
- Go to
android/app/src/main/res/values
and renameconfig.xml.example
toconfig.xml
(and change its values to match your API keys) - Rename
config.example.js
toconfig.js
and change the JWT secret. - Add AR Camera model files to the project.
- On Android, these files are named
optimized_model.tflite
andtaxonomy_data.csv
. They should be placed in a camera folder within Android assets (i.e.android/app/src/main/assets/camera
). - On iOS, these files are named
optimized_model.mlmodel
andtaxonomy.json
and should be added to the Resources folder in XCode.
- Add files to
utility/commonNames
to allow the AR camera to load common names in localized languages. The latest files are attached as assets incommonNames.tar.gz
on the Seek releases page.
- Run
npm start
- Build locally to a device or simulator by running
npm run ios
ornpm run android
Most third-party libraries use autolinking as of React Native 0.60.0. Any exceptions are listed in the react-native.config.js
file. Currently, react-native-inat-camera on Android is manually linked.
- One common issue in React Native involves libraries not being found by the bundler. If this happens, React Native will display an error message that tells you to clear the cache using the following steps:
- Clear watchman:
watchman watch-del-all
- Delete and reinstall node_modules:
rm -rf node_modules && npm install
- Reset the bundler cache:
npm start -- --reset-cache
- Cleaning the project can also help with build issues.
- To do this on Android, run
./gradlew clean
from within theandroid
directory. - For iOS, use XCode > Product > Clean Build Folder.
We do our translations on Crowdin. Head over to https://crowdin.com/project/seek and create an account, and you can start suggesting translations there. We regularly export translations from Crowdin and import them to this project.