{"id":18914675,"url":"https://github.com/helium/hotspot-app","last_synced_at":"2025-04-09T12:02:22.247Z","repository":{"id":36988343,"uuid":"304734484","full_name":"helium/hotspot-app","owner":"helium","description":"Helium hotspot app for iOS and Android","archived":false,"fork":false,"pushed_at":"2023-02-17T20:19:06.000Z","size":30419,"stargazers_count":189,"open_issues_count":64,"forks_count":135,"subscribers_count":38,"default_branch":"main","last_synced_at":"2025-04-02T10:35:00.783Z","etag":null,"topics":["cryptocurrency","helium","hnt","react-native"],"latest_commit_sha":null,"homepage":"https://www.helium.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/helium.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-16T20:41:27.000Z","updated_at":"2024-12-18T15:47:51.000Z","dependencies_parsed_at":"2023-02-18T02:15:48.603Z","dependency_job_id":null,"html_url":"https://github.com/helium/hotspot-app","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helium%2Fhotspot-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helium%2Fhotspot-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helium%2Fhotspot-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helium%2Fhotspot-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helium","download_url":"https://codeload.github.com/helium/hotspot-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248036060,"owners_count":21037092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cryptocurrency","helium","hnt","react-native"],"created_at":"2024-11-08T10:12:25.098Z","updated_at":"2025-04-09T12:02:22.208Z","avatar_url":"https://github.com/helium.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hotspot App\n\nHelium hotspot app for iOS and Android built using [React Native](https://reactnative.dev).\nFor a list of issues and prioritization, please go to our [Project page](https://github.com/orgs/helium/projects/8).\n\n## Get the app\n\n### Release versions of the app are available here:\n\n- [Hotspot App for iOS](https://apps.apple.com/us/app/helium-hotspot/id1450463605)\n  on the iTunes App Store\n- [Hotspot App for Android](https://play.google.com/store/apps/details?id=com.helium.wallet\u0026hl=en_US\u0026gl=US)\n  on the Google Play Store\n  - Or if you don't use Google Play, you can [download an\n    APK](https://install.appcenter.ms/orgs/helium/apps/hotspot-app-android/distribution_groups/public)\n    from the official AppCenter build.\n\n### Beta Versions of the app are available here:\n\n- [TestFlight for iOS](https://testflight.apple.com/join/qX0kqa9j)\n- [Beta for Android](https://play.google.com/apps/testing/com.helium.wallet), or sign up via the Google Play Store Beta button.\n\n## What to expect in the new Hotspot App\n\n### Simplification\n\nWe've heard that the existing app can be overwhelming and cause undue stress and \"doom scrolling\". To fix this, the new app will prefer synthesized summaries over raw activity feeds to help users understand the network and their Hotspot better.\n\n### Visualization\n\nWe will use charts and graphs to explain mining performance over time, and maps to show your Hotspot in relation to others around you. We know witnesses matter, and we want to show you where they are.\n\n### Recommendation Engine\n\nThe new Hotspot app will include a recommendation engine which will suggest actionable steps users can take to improve the performance of their Hotspot.\n\n## Join us in Discord\n\nChat with the developers and the product team in the [Helium Community Discord](https://discord.gg/helium) and look for the #hotspot-app-development channel.\n\n## App Designs\n\nComing soon!\n\n## Getting Started\n\n### React Native Dev Setup\n\nIf you have already set up react native on your machine, skip to the [installing](#Installing) section.\n\n#### React Native dependencies\n\nYou will need Node, Watchman, Yarn, the React Native command line interface, Android Studio, and Xcode.\n\nWhile you can use any editor of your choice to develop your app, you will need to install Xcode and Android Studio in order to set up the necessary tooling to build your React Native app for iOS and Android.\n\nA good free editor is [Visual Studio Code](https://code.visualstudio.com/).\n\n#### Node, Watchman, Yarn\n\nWe recommend installing Node, Yarn, and Watchman using [Homebrew](http://brew.sh/). Run the following commands in a Terminal after installing Homebrew:\n\n```\nbrew install node\nbrew install watchman\nbrew install yarn\n```\n\nIf you have already installed Node on your system, make sure it is up to date with the LTS version.\n\nWatchman is a tool by Facebook for watching changes in the filesystem. It is highly recommended you install it for better performance.\n\n#### The React Native CLI\n\nNode comes with npm, which lets you install the React Native command line interface.\n\nRun the following command in a Terminal:\n\n```\nnpm install -g react-native-cli\n```\n\nIf you get an error like Cannot find module 'npmlog', try installing npm directly:\n\n```\ncurl -0 -L https://npmjs.org/install.sh | sudo sh.\n```\n\n#### Xcode\n\nThe easiest way to install Xcode is via the [Mac App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12). Installing Xcode will also install the iOS Simulator and all the necessary tools to build your iOS app.\n\nIf you have already installed Xcode on your system, make sure it is up to date.\n\n#### Command Line Tools\n\nYou will also need to install the Xcode Command Line Tools. Open Xcode, then choose \"Preferences...\" from the Xcode menu. Go to the Locations panel and install the tools by selecting the most recent version in the Command Line Tools dropdown.\n\n#### Java Development Kit\n\nReact Native requires the Java SE Development Kit (JDK). [Download and install JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) if needed.\n\n#### Android development environment\n\nSetting up your development environment can be somewhat tedious if you're new to Android development. If you're already familiar with Android development, there are a few things you may need to configure. In either case, please make sure to carefully follow the next few steps.\n\n##### 1. Install Android Studio\n\n[Download and install Android Studio](https://developer.android.com/studio/index.html). Choose a \"Custom\" setup when prompted to select an installation type. Make sure the boxes next to all of the following are checked:\n\n- Android SDK\n- Android SDK Platform\n- Performance (Intel ® HAXM)\n- Android Virtual Device\n\nThen, click \"Next\" to install all of these components.\n\nIf the checkboxes are grayed out, you will have a chance to install these components later on.\nOnce setup has finalized and you're presented with the Welcome screen, proceed to the next step.\n\n##### 2. Install the Android SDK\n\nAndroid Studio installs the latest Android SDK by default. Building a React Native app with native code, however, requires the Android 28 SDK in particular. Additional Android SDKs can be installed through the SDK Manager in Android Studio.\n\nThe SDK Manager can be accessed from the \"Welcome to Android Studio\" screen. Click on \"Configure\", then select \"SDK Manager\".\n\nSelect the \"SDK Platforms\" tab from within the SDK Manager, then check the box next to \"Show Package Details\" in the bottom right corner. Look for and expand the Android 28 entry, then make sure the following items are all checked:\n\n- Google APIs\n- Android SDK Platform 28\n- Intel x86 Atom_64 System Image\n- Google APIs Intel x86 Atom_64 System Image\n\nNext, select the \"SDK Tools\" tab and check the box next to \"Show Package Details\" here as well. Look for and expand the \"Android SDK Build-Tools\" entry, then make sure that 30-rc1, 29.0.3, and 28.0.3 are selected.\n\nFinally, click \"Apply\" to download and install the Android SDK and related build tools.\n\n##### 3. Configure the ANDROID_HOME environment variable\n\nThe React Native tools require some environment variables to be set up in order to build apps with native code.\n\nAdd the following lines to your \\$HOME/.bash_profile config file:\n\n```\nexport ANDROID_HOME=$HOME/Library/Android/sdk\nexport PATH=$PATH:$ANDROID_HOME/tools\nexport PATH=$PATH:$ANDROID_HOME/platform-tools\n```\n\n## Installing\n\n### Environment Variables\n\n1. Copy the file `.env.sample` and rename it to `.env`.\n2. Once renamed update the values within the file.\n3. In order for maps to load you will need to create your own [Mapbox](https://account.mapbox.com) access token.\n4. You will also need a Mapbox download token to build the Android app. See the [Mapbox Docs](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials) on creating a token with `Downloads:Read` scope. This token needs to be exported as a system environment variable `MAPBOX_DOWNLOAD_TOKEN` on your machine.\n\n### Dependencies\n\nInstall 3rd party dependencies\n\n```\nyarn install\n```\n\nYou also need [cocoapods](https://cocoapods.org/) for iOS\n\n```\nsudo gem install cocoapods\n```\n\nThen install the pods for iOS (Not needed for Android)\n\n```\nyarn pod-install\n```\n\nIf the app is not working you may want to clean your workspace and then follow the running the app section below\n\n```\nyarn clean-install\nyarn clean-start\n```\n\n### Running The App\n\n#### iOS\n\nThe fastest way to run the app is on the iOS simulator. Just type:\n\n```\nyarn ios\n```\n\nOr for a release build:\n\n```\nyarn ios-release\n```\n\nYou can also open the `helium.xcworkspace` file in the `/ios` folder using xcode and run the app on your device or any other simulator.\n\n#### Android\n\nSimilar to iOS, run\n\n```\nyarn android\n```\n\nOr for a release build:\n\n```\nyarn android-release\n```\n\nYou can also open the Android project in Android Studio by selecting `open an existing project` and selecting the `/android` folder.\n\n# Debugging\n\nSee [React Native Debugging](https://reactnative.dev/docs/debugging.html).\n\n## Recommended tools\n\n---\n\n### **_Reactotron_**\n\nThe app is configured to use the [Reactotron](https://github.com/infinitered/reactotron) app which can be used to:\n\n- view your application state\n- show API requests \u0026 responses\n- perform quick performance benchmarks\n- subscribe to parts of your application state\n- display messages similar to `console.log`\n- track global errors with source-mapped stack traces including saga stack traces!\n- dispatch actions like a government-run mind control experiment\n- hot swap your app's state using Redux or mobx-state-tree\n- track your sagas\n- show image overlay in React Native\n- track your Async Storage in React Native\n\nThe latest version of Reactotron can be downloaded [here](https://github.com/infinitered/reactotron/releases)\n\n### **_React Native Debugger_**\n\nSee [React Native Debugger](https://github.com/jhen0409/react-native-debugger)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelium%2Fhotspot-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelium%2Fhotspot-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelium%2Fhotspot-app/lists"}