Skip to content

Commit

Permalink
fix: beagle helpers page and add beagle grpc tutorials (#611)
Browse files Browse the repository at this point in the history
* move overview to beagle helpers root page

* delete overview from beagle helpers android page

* delete overview from beagle helpers ios page

* Create overview.md

* Create overview.md

* Create _index.md

* Create _index.md

* create a beagle gRPC tutorial

* Update content/en/get-started/using-beagle-helpers/backend/_index.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>

* fix grammaly

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/overview.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* add linux and mac run guide

* add portuguese page

* fix How Beagle gRPC works

* fix portuguese gramally

* fix Portuguese grammar

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: Luiz Gustavo Gomes Borges <luiz.borges@zup.com.br>

* fix How Beagle gRPC works - grammar

* chore: Add android doc

Signed-off-by: paulomeurerzup <paulo.meurer@zup.com.br>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/backend/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* feat: Beagle gRPC iOS

* fixes in grpc ios pages

* beagle grpc ios pt

* Update content/en/get-started/using-beagle-helpers/android/beagle-grpc.md

Co-authored-by: Uzias Ferreira <63263091+uziasferreirazup@users.noreply.github.com>

* fix beagle grpc backend versions

* fix static version on beagle grpc for android

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/en/faq.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* grpc for beagle web

* add @zup-it/ to the package name

* Update content/en/get-started/using-beagle-helpers/android/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* Update content/pt/get-started/using-beagle-helpers/Android/beagle-grpc.md

Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>

* english fixes

* move gRPC content from beagle helpers to ressources

* fix gRPC pages

* fix gRPC pages

* fix gRPC pages

* fix iOS gRPC tutorial on backend reference shortcode

* fix grpc github repo reference on grpc backend tutorials

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/_index.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-web.md

Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>

* Update content/en/resources/gRPC/beagle-grpc-android.md

Co-authored-by: paulomeurerzup <66129650+paulomeurerzup@users.noreply.github.com>

* Update content/pt/resources/grpc/beagle-grpc-android.md

Co-authored-by: paulomeurerzup <66129650+paulomeurerzup@users.noreply.github.com>

Co-authored-by: carlossteinzup <60155378+carlossteinzup@users.noreply.github.com>
Co-authored-by: Mariana Moreira  <66182661+mdcpmoreira@users.noreply.github.com>
Co-authored-by: igorgiumellizup <73198010+igorgiumellizup@users.noreply.github.com>
Co-authored-by: Luiz Gustavo Gomes Borges <luiz.borges@zup.com.br>
Co-authored-by: paulomeurerzup <paulo.meurer@zup.com.br>
Co-authored-by: Lucas Araújo <lucas.araujo@zup.com.br>
Co-authored-by: Uzias Ferreira <63263091+uziasferreirazup@users.noreply.github.com>
Co-authored-by: Arthur Bleil <arthur.bleil@zup.com.br>
Co-authored-by: jessica-tw <66262423+jessica-tw@users.noreply.github.com>
Co-authored-by: Arthur Bleil <78227085+arthurbleilzup@users.noreply.github.com>
Co-authored-by: paulomeurerzup <66129650+paulomeurerzup@users.noreply.github.com>
  • Loading branch information
12 people committed Jun 18, 2021
1 parent 8ba95c3 commit d7c962a
Show file tree
Hide file tree
Showing 12 changed files with 1,372 additions and 2 deletions.
6 changes: 6 additions & 0 deletions content/en/resources/gRPC/_index.md
@@ -0,0 +1,6 @@
---
title: gRPC
weight: 2
description: >-
This section provide some backend libs that will help you to use Beagle with gRPC.
---
107 changes: 107 additions & 0 deletions content/en/resources/gRPC/beagle-grpc-android.md
@@ -0,0 +1,107 @@
---
title: Beagle gRPC for Android
weight: 16
description: 'Here you will find the **beagle-grpc-android** library to help you use gRPC in a project using Beagle in Android.
This lib will hold almost all necessary configuration to add gRPC into a Beagle Android project.'
---

---

![Maven Central](https://img.shields.io/maven-central/v/br.com.zup.beagle/beagle-grpc?color=green&label=Beagle-gRPC)
![**Maven Central**](https://img.shields.io/maven-central/v/br.com.zup.beagle/android?label=Beagle)

### Requirements

<hr>

Before you start to configure Beagle for your Android system, it’s important to check out if you have installed all the current versions of the following programs: ‌

- JDK 8+ language
- Android API level: at least 19 or higher
- Kotlin 1.3+

### Getting started

<hr>

This tutorial will configure Beagle from the Start.

#### Step 1: Add a configuration on the Gradle file in your project:

- `Add mavenCentral()` into the `All projects` block on your Project Gradle file(build.gradle)<br>

```kotlin
allprojects {
repositories {
google()
jcenter()
mavenCentral()
}
}
```

#### Step 2: Add Kotlin Kapt plugin and 3 dependencies on your application dependency manager (gradle.gradle)<br>

![Maven Central](https://img.shields.io/maven-central/v/br.com.zup.beagle/beagle-grpc?color=green&label=Beagle-gRPC)
![Maven Central](https://img.shields.io/maven-central/v/br.com.zup.beagle/android?label=Beagle)

- Add the packagingOptions code block to the build.gradle file, as in the example below.

- _The version numbers listed below may have been updated. Please check the actual versions on the tags above:_

```kotlin
plugins {
id 'com.android.application'
id 'kotlin-android'
id 'kotlin-android-extensions'
id 'kotlin-kapt'
}

android {
kotlinOptions {
jvmTarget = JavaVersion.VERSION_1_8
}

packagingOptions {
pickFirst 'META-INF/LICENSE.md'
pickFirst 'META-INF/LICENSE-notice.md'
}
}

dependencies {
kapt "br.com.zup.beagle:android-processor:${beagleVersion}"
implementation "br.com.zup.beagle:beagle-grpc:${beagleVersion}"
}
```

#### Step 3: Create an AppHttpClientFactory

- This class will be responsible to provide the `HttpClient` that will be used by Beagle to perform requests.<br>

```
const val BASE_URL = "http://10.0.2.2:8080" // your gRPC host
@BeagleComponent
class AppHttpClientFactory: HttpClientFactory {
override fun create(): HttpClient {
return GrpcClient(BASE_URL, HttpClientDefault())
}
}
```

Here, we are telling Beagle to use `GrpcClient` to perform network requests.<br><br>
Let's look to the constructor params of `GrpcClient`: <br>

- `grpcAddress`: Host of your gRPC server. Every request pointing to this host will be performed by `GrpcClient`.
- `customHttpClient`: All requests made to another host will be performed by this `HttpClient`.

Therefore, a request to `http://10.0.2.2:8080/foo` will be performed by `GrpcClient` and a request to another host, let's say, `http://127.0.1.1:5555/bar` will be performed by `HttpClientDefault`.
<br>

The `HttpClientDefault` implementation can be found at Beagle-Default lib.

<hr>

##### For more on Beagle: Please check our [Beagle](https://github.com/ZupIT/beagle) repository.

##### For more on Beagle-Defaults: Please check our [Beagle-Default]({{< ref path="/get-started/using-beagle-helpers/android/beagle-defaults" lang="en" >}}) documentation.

0 comments on commit d7c962a

Please sign in to comment.