This is the Mushroom Observer mobile application. It is a React Native app for iOS and Android with the goal of allowing users to create observations and upload photos from their mobile device and while in the field.

• Follow the instructions for setting up a React Native development environment until you reach the section "Creating a new application"
• Clone this repository from GitHub using git clone [email protected]:MushroomObserver/mushroom-observer-mobile.git
  • Follow the instructions for adding an SSH key to your GitHub account if you do not already have one added
• Navigate into the project directory using cd mushroom-observer-mobile and then run npm install
• Create .env.development based on .env.template
  • Set MUSHROOM_OBSERVER_API_URL to http://localhost:3000 if using developer-startup, or https://www.mushroomovserver.org for the live site
  • Set MUSHROOM_OBSERVER_API_KEY to one you create on your local development server or the live site
    • To create an API key, go to your Mushroom Observer account preferences and then click "API Key Manager" on the right side
    • Enter a name for your API key and then click "Create a New Key"
    • Use the new key as your app's API key

• Run npm start to start the build server
• In another terminal instance, run npm run android-dev to start the app on an Android emulator or run npm run ios-dev to start the app in an iOS simulator
• Changes should be reflected after a file save

• TypeScript - JavaScript with type support
• React Native - Cross platform development
• Redux Toolkit - Redux helpers for data management
• RTK Query - Data fetching that works with Redux Toolkit
• RNUILib - UI Toolkit for React Native

Information about more specific packages or tools can generally be found at their GitHub repositories.

If you'd like to become an active contributor, please send us a message.