Skip to content

Commit 33ff8e6

Browse files
lolipophasgitbook-bot
authored andcommitted
GITBOOK-767: Firebase-finalized
1 parent 2b28c39 commit 33ff8e6

28 files changed

+121
-70
lines changed
148 KB
Loading

.gitbook/assets/image (1) (1) (2).png

-79.6 KB
Loading

.gitbook/assets/image (1) (1).png

121 KB
Loading

.gitbook/assets/image (1).png

-28.5 KB
Loading

.gitbook/assets/image (2) (8) (1).png

953 KB
Loading

.gitbook/assets/image (2) (8).png

-395 KB
Loading

.gitbook/assets/image (2).png

-156 KB
Loading

.gitbook/assets/image (3) (7).png

953 KB
Loading

.gitbook/assets/image (3).png

-841 KB
Loading

.gitbook/assets/image (4) (7).png

18 KB
Loading

.gitbook/assets/image (4).png

171 KB
Loading

.gitbook/assets/image.png

11.1 KB
Loading

SUMMARY.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@
115115
* [OAuth 2.0](user-guide/integrations/rest-api/oauth-2.0.md)
116116
* [Jet Requests Auth](user-guide/integrations/rest-api/jet-requests-auth.md)
117117
* [Firebase / Firestore](user-guide/integrations/firebase-firestore/README.md)
118+
* [Firestore](user-guide/integrations/firebase-firestore/firestore.md)
118119
* [Import CSV into Firebase](user-guide/integrations/firebase-firestore/import-csv-into-firebase.md)
119120
* [Firebase Cloud Storage](user-guide/integrations/firebase-firestore/firebase-cloud-storage.md)
120121
* [Realtime DB](user-guide/integrations/firebase-firestore/realtime-database.md)
@@ -237,7 +238,7 @@
237238
* [🧮 Data Editor](user-guide/data/README.md)
238239
* [Syncing Schema and Data](user-guide/data/syncing-schema-and-data.md)
239240
* [Managing Columns](user-guide/data/managing-columns.md)
240-
* [Making API requests](user-guide/data/make-an-http-request/README.md)
241+
* [Making API requests](user-guide/data/make-an-http-request.md)
241242
* [Open API Builder](user-guide/data/make-an-http-request/open-api-builder.md)
242243
* [Response Transformer](user-guide/data/make-an-http-request/response-transformer.md)
243244
* [Sorting data](user-guide/data/make-an-http-request/sorting-data.md)

getting-started/part-2-intermediate/perform-api-requests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,6 @@ Simply click `Refresh Data` button to run your request
5555

5656
![](../../.gitbook/assets/GIF115.gif)
5757

58-
{% content-ref url="../../user-guide/data/make-an-http-request/" %}
59-
[make-an-http-request](../../user-guide/data/make-an-http-request/)
58+
{% content-ref url="../../user-guide/data/make-an-http-request.md" %}
59+
[make-an-http-request.md](../../user-guide/data/make-an-http-request.md)
6060
{% endcontent-ref %}

getting-started/pixel-perfect-app/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To familiarize yourself with how `Customize with Designer` works, let's build a
88

99
{% embed url="https://www.youtube.com/watch?v=-u6X4gpCWj8&t=16s&ab_channel=JetAdmin" %}
1010

11-
<figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
11+
<figure><img src="../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>
1212

1313
We'll go through the whole **process of creation** step-by-step.&#x20;
1414

user-guide/data/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ description: >-
2020
* Manage your Collection by Adding/Editing rows
2121
* Search, Filter, and Sorting your Collection Data
2222
* Define [Relations](../computed-columns/relations.md) between Collections
23-
* Making [API requests](make-an-http-request/) and [SQL queries](make-a-sql-query.md)
23+
* Making [API requests](make-an-http-request.md) and [SQL queries](make-a-sql-query.md)
2424

2525
You handle the Data when you add a resource to your component. Collections are visualizations of the data that Jet gets from your resources.
2626

user-guide/data/make-an-http-request/README.md renamed to user-guide/data/make-an-http-request.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
description: In this section you will find an overview of HTTP request
2+
description: An overview of HTTP request
33
---
44

55
# Making API requests
66

77
To quickly connect a custom API use HTTP Request Builder. You can make `GET` request to visualize order data in the Table component or `POST` request to reset a password for a specific user.&#x20;
88

9-
![](<../../../.gitbook/assets/image (847).png>)
9+
![](<../../.gitbook/assets/image (847).png>)
1010

1111
Watch the video below on how to get API Builder set up!
1212

user-guide/design-and-structure/components/form/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Form
22

3-
Submit a **Form** to perform actions with input data. The Form component provides a way for users to view and manipulate multiple data fields with their inputs. Upon submission, forms perform functions like creating (inserting) a new data record, updating an existing record, or [calling APIs](../../../data/make-an-http-request/).
3+
Submit a **Form** to perform actions with input data. The Form component provides a way for users to view and manipulate multiple data fields with their inputs. Upon submission, forms perform functions like creating (inserting) a new data record, updating an existing record, or [calling APIs](../../../data/make-an-http-request.md).
44

55
{% embed url="https://vimeo.com/817555123" %}
66

Original file line numberDiff line numberDiff line change
@@ -1,63 +1,52 @@
11
---
2-
description: How to business apps on top of Firebase data
2+
description: How to build business apps on top of Firebase data
33
---
44

55
# Firebase / Firestore
66

7-
In this article, we'll review the integration with Firebase, and its characteristics, and will go through the steps necessary to connect it to Jet Admin
7+
In this article, we'll review the integration with Firebase and will go through the steps necessary to connect it to Jet Admin
88

99
### Connecting Firebase
1010

11-
You can connect to Firebase from the new app flow, from the data tab on the left menu bar, or from the data section within a UI component.
11+
To connect to Firebase from the new app flow, follow the steps:
1212

13-
Then, you'll need to provide a **service token** to allow your Firebase to interact with Jet. You can either copy and paste a JSON snippet **(1)** or upload it as a file **(2)**:
13+
1. Select the `Data` Tab from the **left menu bar**
14+
2. Click on the `Add Resource` button
15+
3. Choose **Firebase** resource
1416

15-
![](../../../.gitbook/assets/xngfhy.png)
17+
{% @arcade/embed flowId="02StOgDDTvaChE64xFrW" url="https://app.arcade.software/share/02StOgDDTvaChE64xFrW" %}
1618

17-
{% hint style="danger" %}
18-
**It's critical** to have a **proper data structure** in your Firebase database, otherwise, Jet might not detect all or some parts of it. To learn, how to properly structure your data, read the [official Firebase article](https://firebase.google.com/docs/database/web/structure-data).
19-
{% endhint %}
19+
### Obtain service token
2020

21-
To obtain a service key, go to your Firebase console, select a project, then proceed to the "Service accounts" section and click "Generate new private key":
21+
You'll need to paste a service token to allow your Firebase to interact with Jet. You can copy and paste or upload a JSON snippet as a file.
2222

23-
![](../../../.gitbook/assets/dtxhfgy.gif)
23+
To copy and paste a JSON snippet, follow the steps:
2424

25-
Then you'll need to select the database type: Firestore or Realtime DB:
25+
1. In the form, paste the **Service Token**
26+
2. Alternatively, you can upload the Service token as a file
2627

27-
![](../../../.gitbook/assets/tjhyu.png)
28+
{% @arcade/embed flowId="niLLzEwkvhIKSCNtaAXw" url="https://app.arcade.software/share/niLLzEwkvhIKSCNtaAXw" %}
2829

29-
{% hint style="info" %}
30-
To learn more about Firestore and Realtime DB, check the [**official Firebase article**](https://firebase.google.com/docs/database/rtdb-vs-firestore)
30+
{% hint style="danger" %}
31+
**It's critical** to have a **proper data structure** in your Firebase database. Otherwise, Jet might not detect all or some parts of it. Read the official Firebase article properly to learn how to structure your data.
3132
{% endhint %}
3233

33-
Further steps vary based on the type of database you want to connect to: Firestore or Realtime DB.
34-
35-
### Firestore
36-
37-
If you selected a Firestore database, you'll be prompted to choose the **connection mode**.
38-
39-
Here, you need to choose how you'd like your Firestore to be integrated with Jet Admin. You can either connect directly or sync it with Jet's internal database to get extended functionality.&#x20;
34+
To obtain a service key, follow the steps:
4035

41-
If you want to be able to **combine** your **Firestore data** with data from other data sources, such as Google Sheets, Airtable, or even REST API within the same tables, you should choose the **"Sync" connection**. You can learn more about it here:
36+
1. Click on the `Settings` button
37+
2. Choose **Project Settings**
38+
3. Go to the **Service Account tab**
39+
4. Click on the `Generate new private key` button
40+
5. Click on the `Generate key` button
4241

43-
{% content-ref url="../../data-blending.md" %}
44-
[data-blending.md](../../data-blending.md)
45-
{% endcontent-ref %}
42+
{% @arcade/embed flowId="HgPGN726gSBgt5035iCh" url="https://app.arcade.software/share/HgPGN726gSBgt5035iCh" %}
4643

47-
![](../../../.gitbook/assets/xgncf.JPG)
48-
49-
After having connected your Firestore, you'll be prompted to choose collections you want Jet Admin to generate **an admin panel (CRUD pages)** for. If you don't want an admin panel to be generated at all, leave all the boxes empty.
50-
51-
![](../../../.gitbook/assets/cfmgvyn.png)
52-
53-
You can also watch our video on Firebase to learn how to quickly build **admin panels** or **CRUD apps** with Firebase:&#x20;
54-
55-
{% embed url="https://www.youtube.com/watch?v=5TTXZhHHP0I" %}
44+
Then you'll need to select the database type: Firestore or Realtime DB:
5645

57-
### Realtime DB
46+
<figure><img src="../../../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
5847

59-
To learn how to configure your Realtime DB data, read the page below:
48+
{% hint style="info" %}
49+
To learn more about Firestore and Realtime DB, check the [**official Firebase article**](https://firebase.google.com/docs/database/rtdb-vs-firestore)**.**
50+
{% endhint %}
6051

61-
{% content-ref url="realtime-database.md" %}
62-
[realtime-database.md](realtime-database.md)
63-
{% endcontent-ref %}
52+
Further steps vary based on the type of database you want to connect to: Firestore or Realtime DB.

user-guide/integrations/firebase-firestore/firebase-cloud-storage.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: In this section you will learn how to use Firebase Cloud Storage
3+
---
4+
15
# Firebase Cloud Storage
26

37
Before you can use Firebase Cloud storage, you need to obtain a service token key. Follow the steps below to integrate Firebase storage with Jet.‌
@@ -8,13 +12,26 @@ To get the JSON key you need to add Firebase to your Google project. First, go t
812

913
![](<../../../.gitbook/assets/image (791).png>)
1014

11-
First, Choose your Google Account. Then you need to click on **Add project** to get a Firebase Key.​
15+
To create a project, follow the steps:
16+
17+
1. Click on the `Add Project` button
18+
2. Choose a name for the project
19+
3. Click on the `Continue` button
20+
4. Select the **Google Account**
21+
5. Click on the `Create Project` button
22+
23+
{% @arcade/embed flowId="lQDBBnBzvaYovj6DJgYW" url="https://app.arcade.software/share/lQDBBnBzvaYovj6DJgYW" %}
24+
25+
Then go to the Service Accounts to generate a new JSON private key. Once you generate a private key, it will automatically download to your computer.​
1226

13-
![](<../../../.gitbook/assets/GIF (316).gif>)
27+
To generate a private key, follow the steps:
1428

15-
Then you need to go to the Service Accounts to generate a new JSON private key. Once you have generated a private key, it will be automatically downloaded to your computer.​
29+
1. Click on the `Settings` of the **Project Overview**
30+
2. Click on the `Project Settings`
31+
3. Go to the **Service Accounts** tab
32+
4. Click on the `Generate new private key` button
1633

17-
![](<../../../.gitbook/assets/GIF (1) (1).gif>)
34+
{% @arcade/embed flowId="Khzwc6u4GUHfVszt1b7m" url="https://app.arcade.software/share/Khzwc6u4GUHfVszt1b7m" %}
1835

1936
### Add Firebase Storage to Jet Admin <a href="#2-add-firebase-to-jet-admin" id="2-add-firebase-to-jet-admin"></a>
2037

@@ -39,6 +56,6 @@ Here's an example of a JSON Service Key obtained from Firebase:
3956
}
4057
```
4158

42-
Once you have integrated Firebase Storage with Jet you will see a **Storage File Viewer** that'll allow you to access your data. For more information about using storages and uploading files, [see the File Storage and Uploading section.](https://docs.jetadmin.io/user-guide/data/file-storage-and-uploading)
59+
Once you have integrated Firebase Storage with Jet you will see a **Storage File Viewer** that'll allow you to access your data. For more information about using storage and uploading files, [see the File Storage and Uploading section.](https://docs.jetadmin.io/user-guide/data/file-storage-and-uploading)
4360

4461
![](../../../.gitbook/assets/GIF213.gif)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
description: In this section you will learn how to use Firestore
3+
---
4+
5+
# Firestore
6+
7+
If you select a Firestore database, you'll be prompted to choose the **connection mode**.
8+
9+
Here, you must choose how you'd like your Firestore to integrate with Jet Admin. You can connect directly or sync it with Jet's internal database to get extended functionality.&#x20;
10+
11+
If you want to be able to **combine** your **Firestore data** with data from other data sources, such as Google Sheets, Airtable, or even REST API within the same tables, you should choose the **"Sync" connection**. You can learn more about it here:
12+
13+
{% content-ref url="../../data-blending.md" %}
14+
[data-blending.md](../../data-blending.md)
15+
{% endcontent-ref %}
16+
17+
<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
18+
19+
After having connected your Firestore, you'll be prompted to choose collections you want Jet Admin to generate **an admin panel (CRUD pages)** for. If you don't want an admin panel to be generated at all, leave all the boxes empty.
20+
21+
<figure><img src="../../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
22+
23+
You can also watch our video on Firebase to learn how to quickly build **admin panels** or **CRUD apps** with Firebase:&#x20;
24+
25+
{% embed url="https://www.youtube.com/watch?v=5TTXZhHHP0I" %}
26+
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
1+
---
2+
description: In this section you will learn how to use Realtime DB
3+
---
4+
15
# Realtime DB
26

37
### Preparing your data with RealtimeDB Builder
48

5-
Once you have added your resource you will be prompted to create a collection to start preparing your data:
9+
Once you have added your resource you will be prompted to create a collection to start preparing your data. To create a collection, follow the steps:
610

7-
![](../../../.gitbook/assets/testgif30.gif)
11+
1. Click on the `Create Collection` button
12+
2. Name the collection
13+
3. Click on the `Create` button to save it
814

9-
To display your data, you need to define the data structure of your collection. To do this, click the Get Record List button to select the collection to display from your database:
15+
{% @arcade/embed flowId="62bLgK1VQMEvdD0XWwnO" url="https://app.arcade.software/share/62bLgK1VQMEvdD0XWwnO" %}
1016

11-
![](../../../.gitbook/assets/testgif31.gif)
17+
To display your data, you need to define the data structure of your collection. To do this, follow the steps:
1218

13-
Next, you need to save the query so you can use this collection in components:
19+
1. Click the `Get Record List` button&#x20;
20+
2. Select the collection to display from your database
21+
3. Click to save it
1422

15-
![](../../../.gitbook/assets/testgif32.gif)
23+
![](../../../.gitbook/assets/testgif31.gif)
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
description: In this section you will learn how to use Visualize Subcollection
3+
---
4+
15
# Visualize Subcollection
26

7+
To visualize the subcollection, follow the steps:
8+
9+
1. Paste a table on the page
10+
2. From the left menu, choose **Firebase**
11+
3. Choose the collection, you want to visualize&#x20;
12+
313
{% embed url="https://www.loom.com/share/8017daa902994cfb854a44ba879ebf29" %}

user-guide/integrations/graphql.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,6 @@ You can display the results of GraphQL queries as with any other query in Jet Ad
7474

7575
More information about HTTP Requests in our documentation.
7676

77-
{% content-ref url="../data/make-an-http-request/" %}
78-
[make-an-http-request](../data/make-an-http-request/)
77+
{% content-ref url="../data/make-an-http-request.md" %}
78+
[make-an-http-request.md](../data/make-an-http-request.md)
7979
{% endcontent-ref %}

user-guide/integrations/rest-api/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ You can also implement your own custom API using API Builder. For instance, you
1616

1717
![](<../../../.gitbook/assets/image (822).png>)
1818

19-
{% content-ref url="../../data/make-an-http-request/" %}
20-
[make-an-http-request](../../data/make-an-http-request/)
19+
{% content-ref url="../../data/make-an-http-request.md" %}
20+
[make-an-http-request.md](../../data/make-an-http-request.md)
2121
{% endcontent-ref %}
2222

2323
### Connect custom API resource
@@ -32,7 +32,7 @@ Let's start with implementing **Rest API**, select it from the list of available
3232

3333
Once you have connected a REST API, you will need to configure the requests in the Data Editor. For more information, please look at the [Data Editor documentation here:](https://docs.jetadmin.io/user-guide/data/make-an-http-request)
3434

35-
{% content-ref url="../../data/make-an-http-request/" %}
36-
[make-an-http-request](../../data/make-an-http-request/)
35+
{% content-ref url="../../data/make-an-http-request.md" %}
36+
[make-an-http-request.md](../../data/make-an-http-request.md)
3737
{% endcontent-ref %}
3838

user-guide/integrations/rest-api/basic-authentication.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ Notice there is the URL, followed by:
2929

3030
That is what tips you off that this is Basic Auth. The **-u** part signifies Basic Auth, and then the colon at the end tells you this is being sent as a username. In normal Basic Auth, you send the username and password in the following format **username : password** so if you see a **-u** then you know that anything to left of the colon is the username and to the right is the password. In this example, the API key is sent as a username.
3131

32-
{% content-ref url="../../data/make-an-http-request/" %}
33-
[make-an-http-request](../../data/make-an-http-request/)
32+
{% content-ref url="../../data/make-an-http-request.md" %}
33+
[make-an-http-request.md](../../data/make-an-http-request.md)
3434
{% endcontent-ref %}

user-guide/integrations/rest-api/bearer-token.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ Adding an API that uses a bearer token authentication scheme is easy in Jet Admi
1818

1919
![](<../../../.gitbook/assets/image (824).png>)
2020

21-
{% content-ref url="../../data/make-an-http-request/" %}
22-
[make-an-http-request](../../data/make-an-http-request/)
21+
{% content-ref url="../../data/make-an-http-request.md" %}
22+
[make-an-http-request.md](../../data/make-an-http-request.md)
2323
{% endcontent-ref %}

user-guide/integrations/webflow.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ Create a new Collection with your Webflow's query:
3737

3838
<figure><img src="../../.gitbook/assets/webflow_api.jpg" alt=""><figcaption></figcaption></figure>
3939

40-
{% content-ref url="../data/make-an-http-request/" %}
41-
[make-an-http-request](../data/make-an-http-request/)
40+
{% content-ref url="../data/make-an-http-request.md" %}
41+
[make-an-http-request.md](../data/make-an-http-request.md)
4242
{% endcontent-ref %}

0 commit comments

Comments
 (0)