Skip to content

Commit

Permalink
Feature/adds typescript menu (#887)
Browse files Browse the repository at this point in the history
* Removes acl option (#882)

Signed-off-by: Hector Custódio <hector.custodio@zup.com.br>

* Adds Typescript backend menu

Signed-off-by: Hector Custódio <hector.custodio@zup.com.br>

* Fixes C4Model Path

Signed-off-by: Hector Custódio <hector.custodio@zup.com.br>
  • Loading branch information
hectorcustodiozup committed Mar 29, 2022
1 parent 0242f2e commit e368dcf
Show file tree
Hide file tree
Showing 45 changed files with 106 additions and 42 deletions.
4 changes: 2 additions & 2 deletions config/_default/config.toml
Expand Up @@ -46,7 +46,7 @@ menu_new_feature_text = "[NEW]"
[[languages.en.menu.main]]
name = "C4 Model"
weight = 20
url = "./c4model/en/#"
url = "../c4model/en/#"

[[languages.en.menu.main]]
name = "References"
Expand Down Expand Up @@ -74,7 +74,7 @@ menu_new_feature_text = "[NOVO]"
[[languages.pt.menu.main]]
name = "C4 Model"
weight = 20
url = "../c4model/pt-br/#"
url = "../../c4model/pt-br/#"

[[languages.pt.menu.main]]
name = "References"
Expand Down
2 changes: 1 addition & 1 deletion content/en/backend/_index.md
@@ -1,5 +1,5 @@
---
title: Backend
weight: 6
description: 'This section lists all configurations, libs and tutorials related to the backend platform'
description: 'This section lists all the backend technologies Beagle currently supports'
---
13 changes: 13 additions & 0 deletions content/en/backend/kotlin/_index.md
@@ -0,0 +1,13 @@
---
title: Kotlin
weight: 1
type: overview
description: In this Section you will learn how to use Beagle Backend for Kotlin Language
---

---

Before you integrate Beagle into your application to run it on the backend, check if you have already installed all the current versions of the following programs:

- **JDK 8+ language \(Kotlin 1.3+ is recommended\)**
- **Maven 3+**
File renamed without changes.
@@ -1,4 +1,5 @@
---
weight: 1
title: Get Started
description: In this Section you will learn how to install and start using Beagle in you backend application.
---
Expand Up @@ -51,7 +51,7 @@ Follow the steps below to import the project you have created. First, open **int

### Step 1: Configure the project

As a starting point, follow this step by step to [**install the backend**]({{< ref path="/backend/get-started/installing-beagle" lang="en" >}}).
As a starting point, follow this step by step to [**install the backend**]({{< ref path="/backend/kotlin/get-started/installing-beagle" lang="en" >}}).

### Step 2: Define the structure

Expand Down
Expand Up @@ -180,7 +180,7 @@ Remember to always check if you're using the latest version of Beagle. To see th

Well done, your initial configuration is ready to be used!

You can check a screen or server-driven component [**to test the BFF**]({{< ref path="/backend/get-started/using-beagle" lang="en" >}}).
You can check a screen or server-driven component [**to test the BFF**]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="en" >}}).

{{% alert color="danger" %}}
Spring Boot has a known problem involving `WebMvcConfigurationSupport`. It may replace other configurations, including the ones in Beagle's Spring Starter.
Expand All @@ -197,13 +197,13 @@ The annotation`@EnableWebMvc` can have the same problem, which means you should
Well done, your initial configuration is ready to be used!
{{% /alert %}}

You can see more of [**how to use Beagle on the backend**]({{< ref path="/backend/get-started/using-beagle" lang="en" >}}) or how to test a BFF with server-driven components.
You can see more of [**how to use Beagle on the backend**]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="en" >}}) or how to test a BFF with server-driven components.

## **Next Steps**

In this section, you have just done Beagle's** initial installation** on your application!
Now, to keep configuring Beagle:

👉Go to [**initial configurations**]({{< ref path="/backend/get-started/using-beagle" lang="en" >}}) to enable the use of Beagle on your Web project.
👉Go to [**initial configurations**]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="en" >}}) to enable the use of Beagle on your Web project.

👉 If you want to go straight to practice, access our [**tutorial to create a project from scratch**.]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="en" >}})
👉 If you want to go straight to practice, access our [**tutorial to create a project from scratch**.]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="en" >}})
Expand Up @@ -10,7 +10,7 @@ description: >-

## Use configuration

Once you have finished [**Beagle's installation**]({{< ref path="/backend/get-started/installing-beagle" lang="en" >}}), your BFF is fully configured for usage, with default settings.
Once you have finished [**Beagle's installation**]({{< ref path="/backend/kotlin/get-started/installing-beagle" lang="en" >}}), your BFF is fully configured for usage, with default settings.

### CORS (Cross-Origin Resource Sharing)

Expand Down
Expand Up @@ -2,7 +2,7 @@
title: Overview
weight: 1
type: overview
description: In this Section you will learn how to use Beagle Backend
description: In this Section you will learn how to use Beagle Backend for Kotlin Language
---

---
Expand Down
9 changes: 9 additions & 0 deletions content/en/backend/typescript/_index.md
@@ -0,0 +1,9 @@
---
title: Typescript
weight: 1
type: overview
description: In this Section you will learn how to use Beagle Backend for Typescript Language
---

---
[Click here](https://github.com/ZupIT/beagle-backend-ts/wiki/Getting-started) to get started with Beagle Backend for Typescript
10 changes: 10 additions & 0 deletions content/en/backend/typescript/overview.md
@@ -0,0 +1,10 @@
---
title: Overview
weight: 1
type: overview
description: In this Section you will learn how to use Beagle Backend for Typescript Language
---

---

[Click here](https://github.com/ZupIT/beagle-backend-ts/wiki/Getting-started) to get started with Beagle Backend for Typescript
2 changes: 1 addition & 1 deletion content/en/contribute/hugo-shortcodes.md
Expand Up @@ -26,7 +26,7 @@ The best way to make references to **_internal_** links in the documentation is

- It will be rendered as:

[Link Example]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="en">}})
[Link Example]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="en">}})

> To learn more about ref, [click here](https://gohugo.io/content-management/cross-references/)
Expand Down
2 changes: 1 addition & 1 deletion content/en/ios/libs/beagle-grpc-ios.md
Expand Up @@ -60,7 +60,7 @@ When creating your NetworkClientGRPC you have to provide the following parameter

{{% alert color="info" %}}
In this section is assumed that your gRPC server is running in the address `0.0.0.0` at the port `50051`.
Check the [Beagle gRPC Backend page]({{< ref path="/backend/support-libraries/beagle-grpc.md" lang="en" >}}) for more information on running your server.
Check the [Beagle gRPC Backend page]({{< ref path="/backend/kotlin/support-libraries/beagle-grpc.md" lang="en" >}}) for more information on running your server.
{{% /alert %}}

Add the dependency to your Podfile
Expand Down
Expand Up @@ -19,7 +19,7 @@ On the example below, there is a server-driven button in a native screen, and th

For this configuration to work correctly, you need:

- A configured [**BFF**]({{< ref path="/key-concepts#backend-for-frontend" lang="en" >}}) with Beagle, in case you haven't configured yet, check out this [**tutorial**]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="en" >}}).
- A configured [**BFF**]({{< ref path="/key-concepts#backend-for-frontend" lang="en" >}}) with Beagle, in case you haven't configured yet, check out this [**tutorial**]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="en" >}}).

- A configured frontend with Beagle in Android or iOS. Check out the tutorial below:
- [**Android**]({{< ref path="/android/getting-started.md" lang="en" >}})
Expand Down
4 changes: 2 additions & 2 deletions content/en/plugins/live-preview.md
Expand Up @@ -20,12 +20,12 @@ This frontend and backend connection is done through a `WebSocket` on port: `972

To use `Live Preview`, you must:

- Use [**Beagle SDK**]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="en" >}}) in your BFF **;**
- Use [**Beagle SDK**]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="en" >}}) in your BFF **;**
- Install `BeaglePreview` plugin;

### BFF Configuration

You must have a configured BFF with Beagle to use Live Preview. In case you haven't done it, [**click here to download an initial project**](https://github.com/ZupIT/beagle-examples/tree/master/BeagleSampleBackend). As an alternative, [**follow our tutorial on how to implement a Beagle configured backend**]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="en" >}}).
You must have a configured BFF with Beagle to use Live Preview. In case you haven't done it, [**click here to download an initial project**](https://github.com/ZupIT/beagle-examples/tree/master/BeagleSampleBackend). As an alternative, [**follow our tutorial on how to implement a Beagle configured backend**]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="en" >}}).

### **IntelliJ plugin installation**

Expand Down
2 changes: 1 addition & 1 deletion content/en/resources/platform-sorting.md
Expand Up @@ -63,7 +63,7 @@ Button(text = "android only text").forPlatform(BeaglePlatform.ANDROID),
Button(text = "text free for all")
```

You can check [**how to configure this functionality, see Beagle customization section**]({{< ref path="/backend/customization" lang="en" >}}).
You can check [**how to configure this functionality, see Beagle customization section**]({{< ref path="/backend/kotlin/customization" lang="en" >}}).

{{% alert color="info" %}}
If you use Beagle starters, it is not necessary to configure this functionality manually, because it is already configured.
Expand Down
4 changes: 2 additions & 2 deletions content/en/web/angular/using-beagle.md
Expand Up @@ -58,7 +58,7 @@ export class AppModule { }

Now, you need to create a JSON file that will define the components that will be rendered.

For a better experience you could create your JSON outputsthrough a BFF. You will find how to configure a BFF [**here**]({{<ref path = "/backend/get-started/creating-a-project-from-scratch" lang = "pt">}}). This example uses a JSON that is available in the URL http://usebeagle.io.s3-website-sa-east-1.amazonaws.com/start/welcome:
For a better experience you could create your JSON outputsthrough a BFF. You will find how to configure a BFF [**here**]({{<ref path = "/backend/kotlin/get-started/creating-a-project-from-scratch" lang = "en">}}). This example uses a JSON that is available in the URL http://usebeagle.io.s3-website-sa-east-1.amazonaws.com/start/welcome:

{{%alert color="info"%}}
JSON used as example.
Expand Down Expand Up @@ -97,7 +97,7 @@ The code above creates a JSON with two for the components `container` and `text`
After creating your JSON, open the file `beagle.module.ts` generated in the previous step, and enter the remote JSON path as http://usebeagle.io.s3-website-sa-east-1.amazonaws.com/start/ in the baseUrl

{{% alert color="info" %}}
If you want to use your own BFF, it's necessary to have its configured CORS. **See how to do this on** [**use configurations for backend**.]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="en" >}})
If you want to use your own BFF, it's necessary to have its configured CORS. **See how to do this on** [**use configurations for backend**.]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="en" >}})
{{% /alert %}}

```text
Expand Down
2 changes: 1 addition & 1 deletion content/en/web/react/using-beagle.md
Expand Up @@ -35,7 +35,7 @@ At the end of this process, a new file called **beagle-service.ts** will be gene

### **Step 2: Creating the layout definition JSON**

or a better experience you could create your JSON outputsthrough a BFF. You will find how to configure a BFF [**here**]({{<ref path = "/backend/get-started/creating-a-project-from-scratch" lang = "pt">}}). This example uses a JSON that is available in the URL http://usebeagle.io.s3-website-sa-east-1.amazonaws.com/start/welcome:
or a better experience you could create your JSON outputsthrough a BFF. You will find how to configure a BFF [**here**]({{<ref path = "/backend/kotlin/get-started/creating-a-project-from-scratch" lang = "en">}}). This example uses a JSON that is available in the URL http://usebeagle.io.s3-website-sa-east-1.amazonaws.com/start/welcome:

{{% alert color="info" %}}
JSON example .
Expand Down
Expand Up @@ -20,7 +20,7 @@ No exemplo abaixo, um botão server-driven será exibido em uma tela nativa. O r

Para que essa configuração funcione corretamente, você precisa de:

- Um [**BFF**]({{< ref path="/key-concepts#backend-for-frontend" lang="pt" >}}) configurado com o Beagle. Caso não o tenha, veja como configurar nesse [**tutorial**]({{< ref path="/backend/" lang="pt" >}})creating-a-project-from-scratch/case-backend" lang="pt" >}}).
- Um [**BFF**]({{< ref path="/key-concepts#backend-for-frontend" lang="pt" >}}) configurado com o Beagle. Caso não o tenha, veja como configurar nesse [**tutorial**]({{< ref path="/backend/kotlin/" lang="pt" >}})creating-a-project-from-scratch/case-backend" lang="pt" >}}).
- Um frontend configurado com o Beagle para Android. Caso não o tenha, siga o nosso tutorial para configurar um projeto [**Android**]({{< ref path="/android/getting-started.md" lang="pt" >}})

## Passo 1: Criar o componente no backend
Expand Down
2 changes: 1 addition & 1 deletion content/pt/backend/_index.md
@@ -1,5 +1,5 @@
---
title: Backend
weight: 6
description: Nesta seção estão todas as configurações, libs e tutorials relacionados a plataforma backend
description: 'Esta seção lista todas as tecnologias backend que o Beagle da suporte atualmente'
---
13 changes: 13 additions & 0 deletions content/pt/backend/kotlin/_index.md
@@ -0,0 +1,13 @@
---
title: Kotlin
weight: 1
type: overview
description: Nesta seção, você encontra detalhes de como usar o Beagle em uma aplicação backend kotlin.
---

---

Antes de integrar o Beagle à sua aplicação para rodá-lo no backend, é importante validar se sua máquina está com as versões corretas instaladas dos seguintes softwares:

- **JDK 8+ language \(Kotlin 1.3+ é recomendado\)**
- **Maven 3+**
File renamed without changes.
File renamed without changes.
Expand Up @@ -55,7 +55,7 @@ Siga os passos abaixo para importar o projeto que você criou. Primeiro, abra su

### Passo 1: Configurar o projeto

Como ponto de partida, siga o [**passo a passo para instalar o backend**]({{< ref path="/backend/get-started/installing-beagle" lang="pt" >}}).
Como ponto de partida, siga o [**passo a passo para instalar o backend**]({{< ref path="/backend/kotlin/get-started/installing-beagle" lang="pt" >}}).

### Passo 2: Definir a Estrutura

Expand Down Expand Up @@ -225,7 +225,7 @@ Uma estrutura JSON tem que aparecer na sua tela similar a estrutura abaixo:

Se essa não for a resposta que você teve, é necessário checar o processo de configuração. Volte aos passos anteriores e comece pelas classes que apresentam maiores equívocos quando configuradas pela primeira vez.

Se preferir, pegue o projeto pronto no repositório do Beagle e compare com o seu. Acesse o [**repositório**](https://github.com/ZupIT/beagle/tree/master/backend/sample).
Se preferir, pegue o projeto pronto no repositório do Beagle e compare com o seu. Acesse o [**repositório**](https://github.com/ZupIT/beagle/tree/master/backend/kotlin/sample).

{{% alert color="info" %}}
Para que o serviço de backend seja consumido, você deve ter o front-end preparado para o Beagle, seja Android, iOS ou Web. Tudo irá funcionar usando o mesmo JSON do backend.
Expand Down
Expand Up @@ -30,7 +30,7 @@ Se você já tiver atualizado todos estes programas, basta seguir as instruçõe
No momento de criar o microsserviço, recomendamos que você utilize os mesmos mecanismos estabelecidos. Caso este não seja o seu caso, então basta seguir as configurações abaixo.

{{% alert color="warning" %}}
Se o seu time trabalha com microsserviços usando outros frameworks, acesse o [**framework do Beagle**]({{< ref path="/backend/customization/beagle-framework" lang="pt" >}}).
Se o seu time trabalha com microsserviços usando outros frameworks, acesse o [**framework do Beagle**]({{< ref path="/backend/kotlin/customization/beagle-framework" lang="pt" >}}).
{{% /alert %}}

Para uma configuração simples, você pode escolher entre **2 modelos de frameworks** para criar seu BFF:
Expand Down Expand Up @@ -183,7 +183,7 @@ Sempre verifique se você está usando a versão mais recente do Beagle. Para sa

Parabéns, a configuração inicial está pronta para uso!

Você pode conferir um **exemplo prático** de tela ou componente Server-Driven [**para testar o BFF**]({{< ref path="/backend/get-started/using-beagle" lang="pt" >}})
Você pode conferir um **exemplo prático** de tela ou componente Server-Driven [**para testar o BFF**]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="pt" >}})

{{% alert color="danger" %}}
O Spring Boot tem um problema conhecido envolvendo seu `WebMvcConfigurationSupport`. Sua presença substitui outras configurações do Jackson, incluindo a do `Spring Starter`.
Expand All @@ -201,13 +201,13 @@ A anotação `@EnableWebMvc` causa o mesmo problema, o que requer que ela també
Pronto, a configuração inicial está pronta para uso!
{{% /alert %}}

Você pode conferir um **exemplo prático** de [**como testar o Beagle no Backend**]({{< ref path="/backend/get-started/using-beagle" lang="pt" >}}) ou componente Server-Driven para testar o BFF.
Você pode conferir um **exemplo prático** de [**como testar o Beagle no Backend**]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="pt" >}}) ou componente Server-Driven para testar o BFF.

## Próximos Passos

Nesta seção, você fez a **instalação inicial** do Beagle na sua aplicação!
Para continuar a configurar o Beagle:

👉Vá para as [**configurações iniciais**]({{< ref path="/backend/get-started/using-beagle" lang="pt" >}}) para habilitar uso do Beagle no seu projeto Backend
👉Vá para as [**configurações iniciais**]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="pt" >}}) para habilitar uso do Beagle no seu projeto Backend

👉 Se quiser ir direto para prática, acesse nosso [**tutorial para criar um projeto do zero**]({{< ref path="/backend/get-started/creating-a-project-from-scratch" lang="pt" >}})
👉 Se quiser ir direto para prática, acesse nosso [**tutorial para criar um projeto do zero**]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="pt" >}})
Expand Up @@ -10,7 +10,7 @@ description: >-

## Configurações de uso

Quando você finalizar a [**instalação do Beagle**]({{< ref path="/backend/get-started/installing-beagle" lang="pt" >}}), seu BFF estará com a configuração padrão de uso.
Quando você finalizar a [**instalação do Beagle**]({{< ref path="/backend/kotlin/get-started/installing-beagle" lang="pt" >}}), seu BFF estará com a configuração padrão de uso.

### CORS (Cross-Origin Resource Sharing)

Expand Down
Expand Up @@ -2,7 +2,7 @@
title: Visão Geral
weight: 1
type: overview
description: Nesta seção, você encontra detalhes de como usar o Beagle em uma aplicação backend.
description: Nesta seção, você encontra detalhes de como usar o Beagle em uma aplicação backend kotlin.
---

---
Expand Down
Expand Up @@ -294,8 +294,8 @@ Pronto! Sua aplicação estará disponível localmente no endereço:

- Para este exemplo, você precisará de um cliente para obter a resposta do serviço. Recomendamos o [BloomRPC](https://github.com/uw-labs/bloomrpc) para simular uma solicitação local em sua API gRPC

- Você também precisará adicionar os arquivos proto da lib do Beagle gRPC no cliente bloomRPC. Você pode acessar esses arquivos [aqui](https://github.com/ZupIT/beagle-grpc/tree/master/backend/grpc-backend-lib/src/main/proto)
- Você também precisará adicionar os arquivos proto da lib do Beagle gRPC no cliente bloomRPC. Você pode acessar esses arquivos [aqui](https://github.com/ZupIT/beagle-grpc/tree/master/backend/kotlin/grpc-backend-lib/src/main/proto)

### **Leia mais sobre o beagle com gRPC**

#### 👉 Este tutorial está disponível no GitHub com exemplos mais avançados, como headers e interceptors por exemplo. Se você estiver interessado, [acesse-os aqui](https://github.com/ZupIT/beagle-grpc/tree/master/backend/examples)
#### 👉 Este tutorial está disponível no GitHub com exemplos mais avançados, como headers e interceptors por exemplo. Se você estiver interessado, [acesse-os aqui](https://github.com/ZupIT/beagle-grpc/tree/master/backend/kotlin/examples)
9 changes: 9 additions & 0 deletions content/pt/backend/typescript/_index.md
@@ -0,0 +1,9 @@
---
title: Typescript
weight: 1
type: overview
description: Nesta seção você aprende como usar o Beagle Backend para Typescript
---

---
[Clique aqui](https://github.com/ZupIT/beagle-backend-ts/wiki/Getting-started) para começar com o Beagle Backend para Typescript
9 changes: 9 additions & 0 deletions content/pt/backend/typescript/overview.md
@@ -0,0 +1,9 @@
---
title: Visão Geral
weight: 1
type: overview
description: Nesta seção você aprende como usar o Beagle Backend para Typescript
---

---
[Clique aqui](https://github.com/ZupIT/beagle-backend-ts/wiki/Getting-started) para começar com o Beagle Backend para Typescript

0 comments on commit e368dcf

Please sign in to comment.