Skip to content

Commit 9361f24

Browse files
authored
Links Cleanup - Part1 (#68)
* Add Firebase Setup links * Fix Navigation Menu links * Fix pages & hide todos * Update links
1 parent e932d9c commit 9361f24

File tree

40 files changed

+213
-149
lines changed

40 files changed

+213
-149
lines changed

docs/ff-concepts/adding-customization/cloud-functions.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
slug: /concepts/custom-code/cloud-functions
33
title: Cloud Functions
44
description: Learn how to use Cloud Functions in your FlutterFlow app for serverless backend functionality.
5-
tags: [FlutterFlow, Cloud Functions, Serverless, Integration]
5+
tags: [Cloud Functions, Serverless, Integration]
66
sidebar_position: 6
77
keywords: [FlutterFlow, Cloud Functions, Serverless, Integration]
88
---
99

1010
# Cloud Functions
1111

12-
[Cloud Functions](https://firebase.google.com/docs/functions) allows you to run backend code in response to events triggered by Firebase features and HTTPS requests. For example, you want to automatically send a welcome email to users when they sign up for your app. You can do this using a Cloud Function that triggers on Firebase Authentication's user creation event.
12+
[**Cloud Functions**](https://firebase.google.com/docs/functions) allows you to run backend code in response to events triggered by Firebase features and HTTPS requests. For example, you want to automatically send a welcome email to users when they sign up for your app. You can do this using a Cloud Function that triggers on Firebase Authentication's user creation event.
1313

1414
We allow you to write and deploy Firebase Cloud Functions directly within the platform. With an integrated code editor, writing JavaScript cloud functions is quick and user-friendly. Each function has customizable boilerplate settings, including pre-configured essentials like memory, region, and timeout.
1515

1616
:::note
17-
You can find some interesting use cases [*here*](https://firebase.google.com/docs/functions/use-cases).
17+
Read up on some interesting use cases of
18+
[**Cloud Functions**](https://firebase.google.com/docs/functions/use-cases).
1819
:::
1920

2021
## Adding Cloud Functions
@@ -40,7 +41,8 @@ Here are the step-by-step instructions to build such an example:
4041
:::info[Before you Begin]
4142

4243
* Make sure the project is on Blaze plan on Firebase.
43-
* Completed all steps in the [Firebase Setup](/data-and-backend/firebase/firebase-setup).
44+
* Completed all steps in the
45+
[**Firebase Setup**](../../ff-integrations/firebase/connect-to-firebase-setup.md).
4446
:::
4547

4648
### 1. Add page state variables
@@ -50,6 +52,8 @@ For this example, you'll need to set up two [page state variables](/data-and-bac
5052
1. **generatingImage (*****Type: Boolean*****)**: This is used to control the visibility of a
5153
loading indicator during the logo creation process. Its value is set to *True* before initiating the API call and switched to *False* once the logo generation is complete.
5254
5. **logoImage (*****Type: ImagePath*****)**: This is used to hold the generated logo image. After a successful API call, the retrieved image URL is stored here, allowing the logo to be displayed in the Image widget.
55+
56+
<p></p>
5357
![img_6.png](imgs%2Fimg_6.png)
5458

5559
### 2. Build a page
@@ -69,16 +73,18 @@ Few things to note here:
6973

7074
To create and deploy a *Cloud Function* :
7175

72-
1. Click on the **Cloud Functions** from the [*Navigation Menu*]
73-
(/getting-started/ui-builder/navigation-menu) (left side of your screen).
74-
5. Click **+ Add**. This will add the default newCloudFunction*.*
76+
1. Click on the **Cloud Functions** from the
77+
[**Navigation Menu**](../../../docs/intro/ff-ui/builder.md#navigation-menu) (left side of your
78+
screen).
79+
5. Click **+ Add**. This will add the default `newCloudFunction`.
7580
8. Set the **Cloud Function Name**.
7681

7782
#### Boilerplate Settings
7883

7984
On the right side, you can configure the following Boilerplate Settings:
8085
1. **Memory Allocation**: You can specify the amount of memory your function should have when
8186
it's executed based on its complexity and needs. This setting is crucial as it influences the function's performance and the cost of running it. More memory can enhance performance for intensive tasks but also increase costs.
87+
8288
5. **Timeout (s)**: This refers to the maximum amount of time, in seconds, that a function is allowed to run before it is automatically terminated. If your function takes longer to execute, increasing the timeout setting may be necessary. However, be aware that longer timeouts can incur higher costs since billing is based on execution time.
8389
8. **Require Authentication**: Turn on this setting if you want users to be authenticated to execute this cloud function.
8490
11. **Cloud Function Region**: This determines the geographical location of the servers where your functions are hosted and executed. Ideally, you should keep this same as your *Default GCP resource location* and the Cloud Function Region specified in the Firebase Advanced Settings.
@@ -92,6 +98,7 @@ by configuring the input and output.
9298

9399
1. To receive output from a Cloud Function, enable the **Return Value** and choose an
94100
appropriate Type for the output, like 'String' for text. For this example, set it to *ImagePath* to get the URL of the generated logo.
101+
95102
5. To input data: Click **+ Add parameters**. **Name** the parameter, select its **Type**, choose single or multiple items (**Is List** option), and uncheck **Nullable** if the value can be null. For this example, add a parameter 'prompt' with *Type* set to *String*.
96103
8. When using [Custom Data Types](/data-and-backend/custom-data-types), Cloud Function expects JSON, matching each field in the Data Type to a key-value pair in the JSON. If the Data Type is a list, the function expects a list of JSONs. For example, for a custom data type named 'Person' with fields 'Name' and 'Age,' the function should return:
97104

@@ -125,6 +132,7 @@ For a list, the function should return:
125132
#### To deploy
126133
1. Click the `[</>]` icon to view the boilerplate code; a popup will open with the updated
127134
code, and then click **`</> Copy to Editor`**. **Tip**: To see if you are able to deploy the cloud function (before adding your own code), proceed directly with steps 8 and 9.
135+
128136
2. Inside the code editor, add the cloud function code. **Tip**: You can copy the boilerplate code
129137
to [ChatGPT](https://chat.openai.com/) and ask it to write the desired code based on that.
130138
3. Click **Save Cloud Function**.

docs/ff-concepts/adding-customization/custom-files.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ Future setStatusbarColor() async {
6666
}
6767
```
6868

69-
2. Now click on **Custom Functions** from the [*Navigation Menu*](/getting-started/ui-builder/navigation-menu) (left side of your screen) and open the **Custom Files > main.dart**.
69+
2. Now click on **Custom Functions** from the
70+
[**Navigation Menu**](../../../docs/intro/ff-ui/builder.md#navigation-menu) and open the **Custom Files > main.dart**.
7071
5. Determine where to place the code (i.e., **Initial Action** or **Final Action**), click the **+** button, and select the custom action.
7172
8. Click **Save**.
7273

docs/ff-concepts/state-management/state-management.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: State Management
33
description: An overview of state management in FlutterFlow
44
---
55

6-
State management is a crucial concept focused on maintaining and controlling the *state* of an application. Simply put, it involves monitoring the changes within your app and updating the user interface to reflect these changes.
6+
State management is a crucial concept focused on maintaining and controlling the **state** of an application. Simply put, it involves monitoring the changes within your app and updating the user interface to reflect these changes.
77

88
You can think of the UI as a function of your state variables, where changes in these variables directly influence what the UI displays.
99

@@ -28,8 +28,10 @@ You can learn more about state management from this video:
2828
<p></p>
2929

3030
:::tip
31-
To learn more about state management in FlutterFlow, read up on [**Variables**](#) and how [**Page
32-
State**](#), or
31+
To learn more about state management in FlutterFlow, read up on
32+
[**Variables**](../../resources/data-representation/overview.md#variable) and how
33+
[**Page
34+
State**](../../resources/ui-building-blocks/pages/page-lifecycle.md#page-state), or
3335
[**Component State**](#) or [**App State variables**](#) are modified in FlutterFlow.
3436
:::
3537

docs/ff-integrations/authentication/types/firebase-auth/anonymous-login.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@ keywords: [FlutterFlow, Anonymous Login, Authentication, Firebase]
1313

1414
Before getting started with this section:
1515

16-
- Complete [**Firebase Setup**](#)
17-
- Complete [**Initial Setup**](initial-setup.md) required for authentication.
18-
16+
- Complete [**Firebase Setup**](.././../../firebase/connect-to-firebase-setup.md)
17+
- Complete [**Initial Setup**](auth-initial-setup) required for authentication.
1918
- Learn more about the concepts
20-
of [**Anonymous Authentication**](docs/Integrations/Authentication/Concepts/authentication-approaches.md)
19+
of [**Anonymous Authentication**](authentication-approaches.md)
2120
:::
2221

2322
## Enable Anonymous Authentication in Firebase

docs/ff-integrations/authentication/types/firebase-auth/apple-login.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ keywords: [FlutterFlow, Apple Login, Authentication, Firebase]
1212

1313
Apple Sign-In allows users to authenticate using their Apple Accounts.
1414

15-
:::warning
15+
:::warning[Support]
1616

1717
Apple sign-in functionality is only supported for iOS.
1818

@@ -49,11 +49,13 @@ Apple sign-in functionality is only supported for iOS.
4949

5050
Before getting started with this section:
5151

52-
1. Complete [**Firebase Setup**](#).
53-
2. Complete [**Initial setup**](initial-setup.md) required for authentication.
52+
1. Complete [**Firebase Setup**](../../../firebase/connect-to-firebase-setup.md).
53+
2. Complete [**Initial setup**](auth-initial-setup) required for authentication.
5454
3. Created an [**Apple account**](https://appleid.apple.com/account?appId=632&returnUrl=https%3A%2F%2Fdeveloper.apple.com%2Faccount%2F).
55-
4. [**Purchased an Apple Developer membership**](https://developer.apple.com/programs/enroll/). Please see [**this link**](https://developer.apple.com/programs/) for more details on the Apple Developer program and how to sign up.
56-
5. Apple sign-In can not be tested in Run Mode. You will need to test it on a real device or emulator.
55+
4. [**Purchased an Apple Developer membership**](https://developer.apple.com/programs/enroll/).
56+
Read more about the [**Apple Developer Program**](https://developer.apple.com/programs/) and how to sign up.
57+
5. Apple sign-In can not be tested in Run Mode. You will need to test it on a real device or
58+
emulator. Try with Local Run!
5759
:::
5860

5961
## Adding Apple sign-in

docs/ff-integrations/authentication/types/firebase-auth/initial-setup.md renamed to docs/ff-integrations/authentication/types/firebase-auth/auth-initial-setup.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
slug: /integrations/authentication/firebase/initial-setup
33
title: Initial Setup
44
description: Learn how to perform the initial setup for Firebase authentication in your FlutterFlow app.
5-
tags: [FlutterFlow, Initial Setup, Authentication, Firebase]
5+
tags: [Initial Setup, Authentication, Firebase]
66
sidebar_position: 0
77
keywords: [FlutterFlow, Initial Setup, Authentication, Firebase]
88
---
@@ -49,12 +49,11 @@ The 'users' collection stores the information for authenticated users.
4949

5050
:::tip[Skip if...]
5151
You have already enabled 'Create User Collection' while creating a new
52-
project with a Firebase setup.
53-
52+
project with [Firebase Setup](../../../firebase/connect-to-firebase-setup.md).
5453
:::
5554

56-
1. Click on the Firestore tab from the Navigation Menu (left side of your
57-
screen).
55+
1. Click on the Firestore tab from the
56+
[**Navigation Menu**](../../../../../docs/intro/ff-ui/builder.md#navigation-menu).
5857
2. Click on the **+ Create Collection** button. If you have any other collection
5958
already added, you can click on the Plus button.
6059
3. Enter a collection_name (this can be anything, but we recommend 'users') and
@@ -127,7 +126,7 @@ this [link](https://developers.google.com/android/guides/client-auth).
127126

128127
:::warning[Release Guidelines]
129128
While releasing the app, make sure
130-
to [**get the key from Play Console**](https://docs.flutterflow.io/data-and-backend/firebase/authentication/phone-sign-in#release-mode).
129+
to [**get the key from Play Console**](#).
131130
:::
132131

133132
1. Open a terminal window:

docs/ff-integrations/authentication/types/firebase-auth/email-sign-in.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ keywords: [FlutterFlow, Email Login, Authentication, Firebase]
1313

1414
Before getting started with this section:
1515

16-
- Complete [**Firebase Setup**](#)
17-
- Complete [**Initial Setup**](initial-setup.md)
16+
- Complete [**Firebase Setup**](../../../firebase/connect-to-firebase-setup.md)
17+
- Complete [**Initial Setup**](auth-initial-setup)
1818
:::
1919

2020
## Enable Email Login Provider in Firebase

docs/ff-integrations/authentication/types/firebase-auth/facebook-login.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Facebook login allows users to authenticate using their Facebook Accounts.
1919

2020
Before getting started with this section:
2121

22-
- Complete [**Firebase Setup**](#)
23-
- Complete [**Initial Setup**](initial-setup.md)
22+
- Complete [**Firebase Setup**](../../../firebase/connect-to-firebase-setup.md)
23+
- Complete [**Initial Setup**](auth-initial-setup)
2424
:::
2525

2626
## Adding Facebook sign-in

docs/ff-integrations/authentication/types/firebase-auth/github-login.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The GitHub auth provides a convenient way for users to authenticate and log in t
1616

1717
Before getting started with this section:
1818

19-
- Complete [**Firebase Setup**](#).
20-
- Complete [**Initial setup**](initial-setup.md) required for authentication.
19+
- Complete [**Firebase Setup**](../../../firebase/connect-to-firebase-setup.md).
20+
- Complete [**Initial setup**](auth-initial-setup.md) required for authentication.
2121
:::
2222

2323

docs/ff-integrations/authentication/types/firebase-auth/google-login.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Google Sign-In allows users to authenticate using their Google Accounts.
1515

1616
Before getting started with this section:
1717

18-
- Complete [**Firebase Setup**](#)
19-
- Complete [**Initial Setup**](initial-setup.md)
18+
- Complete [**Firebase Setup**](../../../firebase/connect-to-firebase-setup.md)
19+
- Complete [**Initial Setup**](auth-initial-setup)
2020
- Added **SHA-1 key** and regenerated **Config Keys**.
2121
:::
2222

0 commit comments

Comments
 (0)