Skip to content

Commit 0a89fe5

Browse files
committed
[Docs] Deploying ToolJet client
1 parent 6448f3d commit 0a89fe5

File tree

3 files changed

+37
-3
lines changed

3 files changed

+37
-3
lines changed

docs/docs/setup/client.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Deploying ToolJet Client
6+
7+
ToolJet client is a standalone application and can be deployed on static website hostign services such as Netlify, Firebase, S3/Cloudfront, etc.
8+
9+
## Deploying ToolJet client on Firebase
10+
11+
:::tip
12+
You should set the environment variable `TOOLJET_SERVER_URL` ( URL of the server ) while building the frontend.
13+
14+
For example: `TOOLJET_SERVER_URL=https://server.tooljet.io npm run build && firebase deploy`
15+
:::
16+
17+
1. Initialize firebase project
18+
```bash
19+
$ firebase init
20+
```
21+
Select Firebase Hosting and set build as the static file directory
22+
2. Deploy client to Firebase
23+
```bash
24+
$ firebase deploy
25+
```
26+
27+
:::tip
28+
If you want to run ToolJet on your local machine, please checkout the setup section of the contributing guide: [link](/docs/contributing-guide/setup/docker)
29+
:::
30+

docs/docs/setup/heroku.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ sidebar_label: Heroku
77

88
Follow the steps below to deploy ToolJet ( both server & client ) on Heroku:
99

10-
1. Click the buttons bewlow to start one click deployment.
10+
1. Click the button below to start one click deployment.
1111
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/tooljet/tooljet/tree/main)
1212

1313
2. Navigate to Heroku dashboard and go to resources tab to verify that the dyno is turned on.
1414
3. Go to settings tab on Heroku dashboard and select 'reveal config vars'.
1515
4. Configure the mandatory environment variables as per the documentation.
1616
5. The default username of the admin is [email protected] and password is password.
1717

18-
:::warning
18+
:::tip
1919
The one click deployment will create a free dyno and a free postgresql database.
2020
:::
2121

docs/docs/setup/kubernetes.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,8 @@ Use this command to forward the port 3000 of server on the pod to the port 3000
4141
5. You can setup load balancers or Kubernetes services to publish the Kubernetes deployment that you've created. This step varies with cloud providers.
4242
Examples:
4343
Application load balancing on Amazon EKS: https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html
44-
GKE Ingress for HTTP(S) Load Balancing: https://cloud.google.com/kubernetes-engine/docs/concepts/ingress
44+
GKE Ingress for HTTP(S) Load Balancing: https://cloud.google.com/kubernetes-engine/docs/concepts/ingress
45+
46+
:::tip
47+
Once the server is deployed, you can deploy ToolJet client on the provider of your choice. Please read the client deployment documentation [here](/docs/setup/client).
48+
:::

0 commit comments

Comments
 (0)