Jet Admin

https://docs.jetadmin.io
Admin
Jet Admin is an app builder that allows you to create client portals, business apps, and internal...
Tokens:421,270
Snippets:442
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Clone and Install React Example Project

Source: https://docs.jetadmin.io/user-guide/design-and-structure/components/custom-component/create-a-javascript-component

Clones a React example project from GitHub and installs its dependencies using npm. This sets up a basic environment for developing Jet Admin JavaScript components.

```shell
git clone [email protected]:jet-admin/jet-flex-view-react-example.git
cd jet-flex-view-react-example
npm install
```

--------------------------------

### Google SSO SAML2 Setup Guide

Source: https://docs.jetadmin.io/user-guide/security-and-privacy/sign-in-sign-up/google-sso-saml2

Provides a step-by-step guide for setting up Single Sign-On (SSO) using Google SAML2 with Jet Admin. It details the process from creating SSO applications to configuring SAML attributes.

```APIDOC
Google SSO SAML2 Setup:

This section details the process for integrating Google SSO with your Jet Admin project using SAML2.

Prerequisites:
- Custom Domain must be set up for your Jet Admin project.

Steps:
1. Go to SSO Applications in your Jet Admin project.
2. Create a new SSO application.
3. Open your G Suite SAML Apps and create a new one.
4. Select 'SETUP MY OWN CUSTOM APP'.
5. Download the IDP metadata .xml file from G Suite.
6. Specify application basic information in G Suite.
7. Set up the Jet Admin SSO application and copy the Assertion Consumer Service (ACS) URL.
8. Configure the G Suite SAML App with the ACS URL and other required details.
9. Map attributes in the G Suite SAML App to ensure correct user data transfer.
10. Finalize the setup. You are all set to use Google SSO.

Related Topics:
- Token-based Auth
- Firebase Auth
- Auth0
```

--------------------------------

### Start Jet Bridge Application

Source: https://docs.jetadmin.io/user-guide/integrations/database-resources/python-app-installation

Command to run the Jet Bridge application after initial setup and configuration. This command is used on UNIX systems after setting the necessary environment variables.

```bash
jet_bridge
```

--------------------------------

### Jet Admin Deployment Options

Source: https://docs.jetadmin.io/user-guide/integrations/google-sheets

Guides for deploying Jet Admin in various environments, including cloud, self-hosted (Jet Bridge), and on-premise setups. Covers configuration, Docker deployment, updates, and common issues.

```APIDOC
Deployment Options:

1. Cloud Deployment:
   - Description: Deploying Jet Admin on cloud platforms.
   - Details: Specific instructions for cloud hosting providers.

2. Self-hosted Jet Bridge:
   - Description: Running Jet Admin on your own infrastructure using Jet Bridge.
   - SSO on self-deployed Jet Bridge:
     - Description: Configuring Single Sign-On for self-hosted instances.
     - Methods: SAML, OAuth, etc.
   - Using self-deployed HTTP proxy:
     - Description: Setting up an HTTP proxy for self-hosted deployments.
     - Purpose: Load balancing, SSL termination, security.
   - Common Problems:
     - Description: Troubleshooting common issues encountered during self-hosting.
   - Configuration:
     - Description: Environment variables and configuration files for self-hosted setups.

3. On-premise Deployment:
   - Description: Deploying Jet Admin within your private network.
   - Deploy On-Premise Jet Admin with Docker:
     - Description: Step-by-step guide to deploying using Docker containers.
     - Commands: docker run, docker-compose.
   - Update:
     - Description: Procedures for updating an on-premise installation.
   - .env configuration (local host):
     - Description: Configuration settings for local on-premise deployments.
     - Custom Domain Configuration on-premise:
       - Description: Setting up custom domain names for on-premise instances.
     - Email Sending Configuration:
       - Description: Configuring email services for notifications and alerts.
       - Parameters: SMTP server, port, credentials.
     - Nginx Configuration:
       - Description: Nginx server block configuration for proxying requests.
       - Example: proxy_pass, SSL settings.
   - Service Health Check:
     - Description: Monitoring the health status of Jet Admin services.
   - Common Problems:
     - Description: Troubleshooting common issues in on-premise deployments.
   - Superuser access:
     - Description: Gaining administrative access to the system.

4. Database Heroku deployment:
   - Description: Specific deployment instructions for Heroku, focusing on database integration.
```

--------------------------------

### Install Jet Admin On-Premise

Source: https://docs.jetadmin.io/jet-bridge-deployment/on-premise/deploy-on-premise-jet-admin-with-docker

This command downloads and executes a shell script from a specified URL to install Jet Admin on your system. Ensure you use your personalized project link for the installation.

```bash
sudo sh -c "$(curl -sS https://link-dev.jetadmin.io/install/o23b1j05tktey5glysf504xm6ayi5mklao3kuf60ltt9jzjl)"
```

--------------------------------

### Google OAuth 2.0 Authentication Setup

Source: https://docs.jetadmin.io/user-guide/security-and-privacy/sign-in-sign-up/google-oauth-2

Guide to setting up Google OAuth 2.0 authentication. This involves obtaining a Client ID and Client Secret from the Google API Console, which are essential for authenticating with Google services.

```APIDOC
Google SSO OAuth 2.0

Step-by-step guide to authentication with Google OAuth 2.0

If you want to use Google services such as Google Sheets, Google Drive, Google Cloud and many others, this step-by-step guide can help you with Google OAuth 2.0 authentication.

Once you have created the project and selected the Rest API resource, you also selected the OAuth 2.0 authentication method - you need to select a provider.

Google Developers Console

1. Google API Console
   Visit the Google API Console (https://console.developers.google.com/) to obtain OAuth 2.0 credentials such as a `Client ID` and `Client secret` that are known to both Google and Jet Admin.
```

--------------------------------

### Install Jet Bridge for Python 3

Source: https://docs.jetadmin.io/user-guide/integrations/database-resources/python-app-installation

Installs the Jet Bridge Python package using pip3. This is the primary command to get the Jet Bridge library installed in your Python environment.

```python
pip3 install jet_bridge -U
```

--------------------------------

### Jet Admin Figma Design Import

Source: https://docs.jetadmin.io/user-guide/design-and-structure/components/form/examples

Guides users on how to import Figma designs into Jet Admin. Includes instructions for installing the necessary plugin.

```APIDOC
Import Figma Design:
  - Overview: /import-figma-design
  - Install Plugin: /import-figma-design/install-plugin
```

--------------------------------

### API Response Example (201 Created)

Source: https://docs.jetadmin.io/user-guide/jet-admin-api/pages-api

An example of a successful API response indicating resource creation. It includes details about the created resource, its environment, view, name, and complex configuration parameters.

```JSON
{
    "uid": "0475c2aa-bbe3-4f9f-a331-a5d36b24246d",
    "environment": "prod",
    "view": "custom",
    "unique_name": "airtable_appKwTLUIAkgt6rKQ_tblMX2fShSr5C7O6n",
    "name": "Table 1",
    "resource": "airtable_2a96",
    "model": "appKwTLUIAkgt6rKQ_tblMX2fShSr5C7O6n",
    "params": "{\"parameters\":[],\"elements\":[{\"uid\":\"dps97441\",\"name\":\"Filter\",\"type\":\"filter\",\"margin\":{},\"visible_input\":null,\"params\":{\"elements\":[\"znhipkrw\"],\"element_inputs\":[{\"name\":\"Name__icontains\",\"settings\":{\"verboseName\":\"Name\"}},{\"name\":\"Status\",\"settings\":{\"verboseName\":\"Status\"}},{\"name\":\"Notes__icontains\",\"settings\":{\"verboseName\":\"Notes\"}},{\"name\":\"Calculation__icontains\",\"settings\":{\"verboseName\":\"Calculation\"}}],\"style\":\"background\"}},{\"uid\":\"znhipkrw\",\"name\":\"Table\",\"type\":\"list\",\"margin\":{},\"visible_input\":null,\"params\":{\"height\":600,\"layouts\":[{\"type\":\"table\",\"header\":true,\"title_input\":{\"name\":\"value\",\"value_type\":\"static_value\",\"static_value\":\"Table 1\",\"required\":false},\"data_source\":{\"type\":\"query\",\"query_resource\":\"airtable_2a96\",\"input\":null,\"query\":{\"query_type\":\"simple\",\"simple_query\":{\"model\":\"appKwTLUIAkgt6rKQ_tblMX2fShSr5C7O6n\"},\"pagination_total_path\":[],\"pagination_cursor_prev_path\":[],\"pagination_cursor_next_path\":[],\"pagination_has_more_pages_path\":[],\"pagination_has_more_total_pages_path\":[],\"pagination_has_more_total_records_path\":[],\"sorting\":false,\"frontend_filtering\":false},\"query_parameters\":[],\"query_inputs\":[{\"name\":\"Name__icontains\",\"value_type\":\"context\",\"context_value\":[\"elements\",\"dps97441\",\"Name__icontains\",\"value\"],\"required\":false},{\"name\":\"Status\",\"value_type\":\"context\",\"context_value\":[\"elements\",\"dps97441\",\"Status\",\"value\"],\"required\":false},{\"name\":\"Notes__icontains\",\"value_type\":\"context\",\"context_value\":[\"elements\",\"dps97441\",\"Notes__icontains\",\"value\"],\"required\":false},{\"name\":\"Calculation__icontains\",\"value_type\":\"context\",\"context_value\":[\"elements\",\"dps97441\",\"Calculation__icontains\",\"value\"],\"required\":false}],\"columns\":[{\"type\":\"base\",\"name\":\"Name\",\"verboseName\":\"Name\",\"field\":\"text\",\"visible\":true,\"params\":{\"length\":null,\"source_field_type\":\"singleLineText\"}},{\"type\":\"base\",\"name\":\"Notes\",\"verboseName\":\"Notes\",\"field\":\"text\",\"visible\":true,\"params\":{\"length\":null,\"multiline\":true,\"source_field_type\":\"multilineText\"}},{\"type\":\"base\",\"name\":\"relation\",\"verboseName\":\"relation\",\"field\":\"related_model\",\"visible\":true,\"params\":{\"related_model\":{\"model\":\"airtable_2a96.appKwTLUIAkgt6rKQ_tblMX2fShSr5C7O6n\"},\"length\":null,\"source_field_type\":\"multipleRecordLinks\"}},{\"type\":\"base\",\"name\":\"Attachments\",\"verboseName\":\"Attachments\",\"field\":\"file\",\"visible\":true,\"params\":{\"length\":null,\"storage_resource\":\"demo_rest_api\",\"storage_name\":\"temporary\",\"multiple\":true,\"source_field_type\":\"multipleAttachments\"}},{\"type\":\"base\",\"name\":\"Status\",\"verboseName\":\"Status\",\"field\":\"select\",\"visible\":true,\"params\":{\"length\":null,\"options_type\":\"static\",\"options\":[{\"value\":\"Todo\",\"name\":\"Todo\",\"color\":\"red\"},{\"value\":\"In progress\",\"name\":\"In progress\",\"color\":\"yellow\"},{\"value\":\"Done\",\"name\":\"Done\",\"color\":\"green\"},{\"value\":\"Test\",\"name\":\"Test\",\"color\":\"yellow\"},{\"value\":\"Test2\",\"name\":\"Test2\",\"color\":\"blue\"},{\"value\":\"Test4\",\"name\":\"Test4\",\"color\":\"green\"},{\"value\":\"Test5\",\"name\":\"Test5\",\"color\":\"purple\"},{\"value\":\"Test6\",\"name\":\"Test6\",\"color\":\"teal\"},{\"value\":\"Test7\",\"name\":\"Test7\",\"color\":\"green\"},{\"value\":\"Test3\",\"name\":\"Test3\",\"color\":\"purple\"},{\"value\":\"еуы\",\"name\":\"еуы\",\"color\":\"teal\"},{\"value\":\"фифа\",\"name\":\"фифа\",\"color\":\"red\"},{\"value\":\"db_check\",\"name\":\"db_check\",\"color\":\"red\"},{\"value\":\"anom\",\"name\":\"anom\",\"color\":\"teal\"},{\"value\":\"lol\",\"name\":\"lol\",\"color\":\"purple\"},{\"value\":\"new2\",\"name\":\"new2\",\"color\":\"yellow\"},{\"value\":\"new3\",\"name\":\"new3\",\"color\":\"green\"},{\"value\":\"new4\",\"name\":\"new4\",\"color\":\"purple\"},{\"value\":\"new5\",\"name\":\"new5\",\"color\":\"maroon\"},{\"value\":\"new6\",\"name\":\"new6\",\"color\":\"navy\"},{\"value\":\"new7\",\"name\":\"new7\",\"color\":\"green\"},{\"value\":\"new8\",\"name\":\"new8\",\"color\":\"yellow\"}],\"source_field_type\":\"singleSelect\"}},{\"type\":\"base\",\"name\":\"Multiple Status\",\"verboseName\":\"Multiple Status\",\"field\":\"multiple_select\",\"visible\":true,\"par
```

--------------------------------

### Hubspot Offset Pagination API Example

Source: https://docs.jetadmin.io/user-guide/data/make-an-http-request/pagination/offset-pagination

Demonstrates offset pagination using Hubspot's API structure. This method involves specifying an 'offset' to indicate the starting point in the dataset and a 'limit' to control the number of records returned per request. The example shows both a static offset/limit and a dynamic parameter usage.

```APIDOC
https://api.hubapi.com/v1/deals/v1/deal/paged?offset=20&limit=20

Description: Retrieves the next 10 deals starting from the 20th deal in the dataset.
```

```APIDOC
https://api.hubapi.com/v1/deals/v1/deal/paged?offset={{paging.offset}}&limit={{paging.limit}}

Description: Dynamic usage with templated offset and limit parameters, suitable for integration with systems like Jet API Builder.
```

--------------------------------

### Jet Admin Component Designer Features

Source: https://docs.jetadmin.io/user-guide/security-and-privacy/sign-in-sign-up/custom-sso-oauth-2

Guides on using the Component Designer, including pixel-perfect components, working with the designer interface, right sidebar functionalities (Layout, Auto Layout, Conditional Visibility, Responsiveness, Fills, Borders, Shadows, Interactions), Frames and Groups, Action components, and Component/layer states.

```markdown
- [How to use pixel-perfect components](/component-designer/how-to-use-pixel-perfect-components)
- [How to work with component designer](/component-designer/how-to-work-with-component-designer)
- [Right sidebar](/component-designer/right-sidebar)
  - [Layout](/component-designer/right-sidebar/layout)
  - [Auto Layout](/component-designer/right-sidebar/auto-layout)
  - [Conditional Visibility](/component-designer/right-sidebar/conditional-visibility)
  - [Component Responsiveness / Constraints](/component-designer/right-sidebar/component-responsiveness-constraints)
  - [Fills](/component-designer/right-sidebar/fills)
  - [Borders](/component-designer/right-sidebar/borders)
  - [Shadows](/component-designer/right-sidebar/shadows)
  - [Interactions](/component-designer/right-sidebar/interactions)
- [Frames and Groups](/component-designer/frames-and-groups)
- [Action components](/component-designer/action-components)
- [Component and layer states](/component-designer/component-and-layer-states)
```

--------------------------------

### Run Jet Admin On-Premise

Source: https://docs.jetadmin.io/jet-bridge-deployment/on-premise/deploy-on-premise-jet-admin-with-docker

After installation, navigate to the jet-onpremise directory and use Docker Compose to start Jet Admin and its associated components in detached mode. The application will be accessible via localhost.

```bash
sudo docker-compose up -d
```

--------------------------------

### JetAdmin Deployment Options

Source: https://docs.jetadmin.io/user-guide/core-concept/sharing-your-app

Information on deploying JetAdmin applications, including cloud-hosted, self-hosted, and on-premise options. This section covers configuration and setup for various deployment scenarios.

```APIDOC
Deployment:
  - Cloud: Deployment on cloud infrastructure.
  - Self-hosted Jet Bridge: Instructions for self-deploying Jet Bridge, including SSO, HTTP proxy usage, common problems, and configuration.
  - On-premise: Guides for on-premise deployment using Docker, including updates, .env configuration (custom domains, email, Nginx), service health checks, common problems, and superuser access.
  - Database Heroku deployment: Specific deployment instructions for Heroku.
```

--------------------------------

### Run Development Server

Source: https://docs.jetadmin.io/user-guide/design-and-structure/components/custom-component/create-a-javascript-component

Starts the development server for the JavaScript component project. This command allows you to test your component locally before deploying it to Jet Admin.

```shell
npm run start
```

--------------------------------

### SmartSuite Integration API Details

Source: https://docs.jetadmin.io/user-guide/integrations/smartsuite

Details on connecting to SmartSuite, including obtaining API keys, account IDs, and selecting solutions for integration with Jet Admin.

```APIDOC
SmartSuite Integration:
  Purpose: Connect Jet Admin to SmartSuite data.
  Requirements:
    - Jet Admin Project
    - SmartSuite Account

  Connection Steps:
    1. Navigate to the data tab in Jet Admin.
    2. Enter a valid API Key from SmartSuite.
    3. Enter the Account ID from SmartSuite.
    4. Select the desired SmartSuite Solution from the dropdown.

  Credentials:
    - API Key: Obtain from SmartSuite User Menu -> API Key.
    - Account ID: Found in the SmartSuite URL (e.g., https://app.smartsuite.com/[ACCOUNT_ID]/home).

  Resource Creation:
    - Create separate resources for each SmartSuite solution.
    - Jet Admin supports unlimited resources per SmartSuite solution.
```

--------------------------------

### GraphQL Query Example

Source: https://docs.jetadmin.io/user-guide/integrations/graphql

An example GraphQL query to fetch character data, demonstrating how to request specific fields and nested objects.

```graphql
{
  characters {
    results {
      id
      name
      status
      species
      type
      gender
      origin {
        name
        id
      }
    }
  }
}
```
Tokens:
Raw