{"id":13764701,"url":"https://github.com/ModusCreateOrg/spark-goggles","last_synced_at":"2025-05-10T20:31:05.003Z","repository":{"id":70966810,"uuid":"115447185","full_name":"ModusCreateOrg/spark-goggles","owner":"ModusCreateOrg","description":"Cisco Spark Goggles App","archived":true,"fork":false,"pushed_at":"2018-02-21T20:06:49.000Z","size":2749,"stargazers_count":0,"open_issues_count":14,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-02T11:01:57.001Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ModusCreateOrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2017-12-26T18:53:18.000Z","updated_at":"2024-02-22T17:29:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"41d770c3-2e8d-4e08-b9b9-46551ec1f939","html_url":"https://github.com/ModusCreateOrg/spark-goggles","commit_stats":null,"previous_names":["moduscreateorg/spark-goggles","promptworks/spark-goggles"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModusCreateOrg%2Fspark-goggles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModusCreateOrg%2Fspark-goggles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModusCreateOrg%2Fspark-goggles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModusCreateOrg%2Fspark-goggles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ModusCreateOrg","download_url":"https://codeload.github.com/ModusCreateOrg/spark-goggles/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253480380,"owners_count":21915246,"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":[],"created_at":"2024-08-03T16:00:26.311Z","updated_at":"2025-05-10T20:31:02.877Z","avatar_url":"https://github.com/ModusCreateOrg.png","language":"JavaScript","funding_links":[],"categories":["Code samples"],"sub_categories":["Mobile samples"],"readme":"# :eyeglasses: Spark Goggles [![CircleCI](https://circleci.com/gh/promptworks/spark-goggles.svg?style=svg\u0026circle-token=7a0f4585726eb1d7e5bb1a0c33539faa485804ee)](https://circleci.com/gh/promptworks/spark-goggles)\n\n## :point_up: How to Setup\n\n**Step 1:** Run `git clone git@github.com:promptworks/spark-goggles`.\n\n**Step 2:** Run `cd spark-goggles`.\n\n**Step 3:** Install the dependencies by running `yarn install`.\n\n**Step 4:** Run `yarn start` to start the React Native packager.\n\nYou can see the debugger interface at [http://localhost:8081/debugger-ui/](http://localhost:8081/debugger-ui/).\n\n## :rocket: How to run the App\n\nFirst, you'll need to install the Android SDK. Next, you can either run the app on a device or on an emulator.\n\n#### Emulator\n\n1. Run `yarn android:emulator:create` to create an Android virtual device.\n2. Run `yarn android:emulator` to start the emulator in a tab.\n3. Open another tab, run `yarn android` to launch the app.\n\n#### Device\n\n1. On the device, go into `Settings \u003e About`.\n2. Find the build number. Tap it a bunch of times until it says \"You've unlocked developer mode\".\n3. Go back to the main settings menu.\n4. Find the developer settings section and find \"USB Debugging\". Make sure it's set to on.\n5. Run `yarn android` to launch the app.\n\n#### Tips\n\n* If your device isn't cooperating, run `yarn android:devices` to see the list of connected devices. When correctly configured, the second column should say `device`.\n* To access some of the development settings, you can shake an android device. If you're using the emulator, you can run `yarn android:shake`.\n\n## :no_entry_sign: Linting\n\nTo run the linter, run `yarn lint`. You can fix some of the errors automatically with `yarn lint:fix`. The linter will run automatically when you commit.\n\nIf you have to bypass lint for a special commit that you will come back and clean (pushing something to a branch etc.) then you can bypass git hooks with adding `--no-verify` to your commit command.\n\n## :white_check_mark: Testing\n\nYou can run the tests with `yarn test`.\n\n## :closed_lock_with_key: Secrets\n\nThis project uses [react-native-config](https://github.com/luggit/react-native-config) to expose config variables to your javascript code in React Native. You can store API keys\nand other sensitive information in a `.env` file:\n\n```\nAPI_URL=https://myapi.com\nGOOGLE_MAPS_API_KEY=abcdefgh\n```\n\nand access them from React Native like so:\n\n```javascript\nimport Secrets from 'react-native-config'\n\nSecrets.API_URL  // 'https://myapi.com'\nSecrets.GOOGLE_MAPS_API_KEY  // 'abcdefgh'\n```\n\nThe `.env` file is ignored by git keeping those secrets out of your repo.\n\n## :package: Adding a Native package\n\nIf you add a package that contains Java or ObjC code, you'll need to link it. To do so, you'll simply run `yarn react-native link`.\n\nAfter linking, you'll want to re-build the app entirely: `yarn android`.\n\n## :shipit: Generating a release\n\nFirst, you'll need a `.keystore` file. To generate this file, you can run `yarn keytool`. Answer each question, and don't forget the passwords you've chosen!\n\nAfter running this script, you should find a file called `android/app/spark-goggles.keystore`. If you plan to release the app to Google Play, you'll want to make sure that you don't lose this file.\n\nNext, you'll need to configure a few build variables. You'll need to drop the following configuration in `~/.gradle/gradle.properties`:\n\n```\nSPARK_GOGGLES_RELEASE_STORE_FILE=spark-goggles.keystore\nSPARK_GOGGLES_RELEASE_KEY_ALIAS=spark-goggles\nSPARK_GOGGLES_RELEASE_STORE_PASSWORD=*****\nSPARK_GOGGLES_RELEASE_KEY_PASSWORD=*****\n```\n\nFinally, to build an `.apk` file, you can run `yarn android:build`. This will generate `android/app/build/outputs/apk/app-release.apk`.\n\nFor more information, consult the [React Native documentation](https://facebook.github.io/react-native/docs/signed-apk-android.html).\n\n*NOTE:* It is imperative that you don't commit the .keystore file or any passwords.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FModusCreateOrg%2Fspark-goggles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FModusCreateOrg%2Fspark-goggles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FModusCreateOrg%2Fspark-goggles/lists"}