Skip to content

Commit

Permalink
improve guides (#590)
Browse files Browse the repository at this point in the history
  • Loading branch information
vonovak committed Dec 10, 2018
1 parent e069d43 commit e5bb65f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 18 deletions.
21 changes: 4 additions & 17 deletions docs/CONTRIBUTING.md
Expand Up @@ -2,24 +2,11 @@

Want to add a feature or fix a bug? Great! This short guide will help.

Development is best done using the example project. After you clone the repo, you need to
Development is best done using the example project. After you clone the repo, see the example project's [readme](../example/README.md) for instructions on how to get it running.

- get the config files from firebase: see [here](get-config-file.md)
- cd to the example folder
- run `yarn` to install deps
- create `config.js` with the following content:
When done, the example project should build successfully on both platforms and you should be able to sign in using the example app.

```js
export default {
webClientId: 'your-id.apps.googleusercontent.com',
};
```

- cd to the `ios` folder and run `pod install`

Now the example project should build successfully on both platforms and you should be able to sign in using the example app.

### Making Change to Native Code
### Making Changes to Native Code

If you want to make changes to native code, just go ahead and import the example project into Android Studio, or open the `GoogleSigninSampleApp.xcworkspace` file in Xcode.

Expand All @@ -28,7 +15,7 @@ in Xcode, under Libraries, there'll be `RNGoogleSignIn` project.

You may edit the source codes of those projects - that will edit the files in the `android` and `ios` folders in the repo root (not in `node_modules`) so you can easily commit those changes.

### Making Change to JS Code
### Making Changes to JS Code

There is a little more work to make changes to JS code. The process is not ideal but works as follows:

Expand Down
9 changes: 8 additions & 1 deletion example/README.md
Expand Up @@ -2,11 +2,18 @@

### Setup

- To get this running you should have:
- To get this running you should have (see [how to get config files](get-config-file.md)):
- `google-services.json` in your `android/app/`
- `GoogleService-Info.plist` in `ios/` and linked in XCode by dragging it to the file tree.
- Run `yarn` on project root to install required Javascript dependencies
- Go to `ios/` and run `pod install` to install required native iOS dependencies
- create `config.js` with the following content:

```js
export default {
webClientId: 'your-id.apps.googleusercontent.com',
};
```

### Running

Expand Down

0 comments on commit e5bb65f

Please sign in to comment.