@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/connections/Stripe.yaml

@@ -1,139 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: Stripe
-    pageTitle: Stripe
-    section: Connections
-    filePath: connections/Stripe.yaml
-    content:
-      - id: markdown
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Stripe
-
-            ### Stripe
-
-            [Stripe](https://stripe.com/) is a popular payment provider which allows you to accept payments, send payouts, and manage your business online.
-            The `Stripe` connector uses the official [Node.js client from Stripe](https://github.com/stripe/stripe-node).
-            In order to use the `Stripe` connection, you first need to create a [Stripe](https://stripe.com/) account and setup an API key.
-
-            > Secrets like API keys should be stored using the [`_secret`](operators/secret.md) operator.
-
-            #### Properties
-            - `secretKey: string`: __Required__ - Stripe [secret key](https://stripe.com/docs/keys).
-            - `apiVersion: string`: Stripe API version to use. Defaults to the account-wide version.
-            - `timeout: number`: Timeout for requests to the Stripe API.
-            - `maxNetworkRetries: number`: Maximum number of times failed requests are repeated before throwing an error.
-            - `telemetry: boolean`: Whether to send telemetry data to Stripe (this is forwarded to the Stripe client library. Lowdefy does not receive any telemetry data from your Stripe connection.)
-
-            #### Examples
-
-            ###### Simple connection:
-            ```yaml
-            connections:
-              - id: stripe
-                type: Stripe
-                properties:
-                  secretKey:
-                    _secret: STRIPE_SECRET_KEY
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
-            ```
-
-            ###### Using an older API version:
-            ```yaml
-            connections:
-              - id: stripe
-                type: Stripe
-                properties:
-                  secretKey:
-                    _secret: STRIPE_SECRET_KEY
-                  apiVersion: 2017-12-14
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
-            ```
-
-            ## Requests
-
-            Request types:
-              - StripeRequest
-
-            ### StripeRequest
-
-            The `StripeRequest` request allows calls to all modules supported by the [Stripe API client](https://stripe.com/docs/api?lang=node) by nesting the resource and method calls:
-            ```yaml
-            resource:
-              method:
-                - parameter1
-                - parameter2
-            ```
-
-            #### Properties
-            - `{{ apiResource }}: object`: A Stripe API resource, eg. `customers`.
-              - `{{ method }}: array | null`: A resource method, eg. `create`. The arguments array will be passed on to the client method.
-
-            The Stripe client exposes all resources as objects, with the API methods being available as function properties on those resource objects.
-            In Lowdefy, you may access these properties by nesting them.
-
-            ### Examples
-
-            ###### List the 30 most recent customers
-            ```yaml
-            requests:
-              - id: list_customers
-                type: StripeRequest
-                connectionId: stripe
-                properties:
-                  customers:
-                    list:
-                      limit: 30
-            ```
-
-            ###### Create a payment intent
-            ```yaml
-            requests:
-              - id: create_payment_intent
-                type: StripeRequest
-                connectionId: stripe
-                properties:
-                  paymentIntents:
-                    create:
-                      - amount: 2000
-                        currency: eur
-                        payment_method_types: [ card ]
-            ```
-
-            ###### Retrieve a checkout session by ID
-            ```yaml
-            requests:
-              - id: retrieve_checkout_session
-                type: StripeRequest
-                connectionId: stripe
-                properties:
-                  checkout:
-                    sessions:
-                      retrieve:
-                        - cs_test_onpT2icY2lrSU0IgDGXEhhcOHcWeJS5BpLcQGMx0uI9TZHLMBdzvWpvx
-            ```

package/deployment/aws-lambda.yaml

@@ -1,128 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: aws-lambda
-    pageTitle: Deploy with AWS Lambda
-    section: Deployment
-    filePath: deployment/aws-lambda.yaml
-    content:
-      - id: md1
-        type: Markdown
-        properties:
-          content: |
-            Lowdefy apps can be deployed to AWS Lambda serverless functions by using the [lowdefy/lowdefy-aws-lambda](https://hub.docker.com/repository/docker/lowdefy/lowdefy-aws-lambda) Docker images. These images contain a Lowdefy app server. To deploy to AWS Lambda a new image that contains the app configuration, based on the Lowdefy base image, should be built. This image should then be pushed to a private AWS ECR registry. From there it can be used to create a Lambda function.
-
-            The [serverless framework](https://www.serverless.com) can be used to simplify the deployment. The serverless framework create a ECR registry if it does not exist, build the Docker image, push to the registry and deploy an AWS Lambda function with a API Gateway HTTP api integration.
-
-            An example can be found in the [lowdefy-example-aws-lambda](https://github.com/lowdefy/lowdefy-example-aws-lambda)  repository.
-
-            ## Deploying to AWS Lambda
-
-            ### Requirements
-
-            - The [AWS CLI](https://aws.amazon.com/cli/) should be installed and authenticated.
-            - You should have [Docker](https://docs.docker.com/get-docker/) installed.
-
-            ### Step 1 - Create a Dockerfile
-
-            Create a file called `Dockerfile` in your project repository:
-
-            ```
-            FROM node:14-buster AS build
-
-            # Set working directory and node user
-            WORKDIR /home/node/lowdefy
-
-            RUN chown node:node /home/node/lowdefy
-
-            USER node
-
-            # Copy app config, and change ownership of files to "node" user
-            COPY  --chown=node:node  . .
-
-            # Build the Lowdefy config using the Lowdefy CLI
-            RUN npx lowdefy@3.23.2 build
-
-            # Use the correct Lowdefy base image
-            FROM lowdefy/lowdefy-aws-lambda:3.23.2
-
-            # Copy build output from build stage
-            COPY --from=build /home/node/lowdefy/.lowdefy/build ./build
-
-            # Copy contents of public directory into image
-            COPY ./public ./public
-
-            # Lambda handler
-            CMD [ "dist/server.handler"]
-            ```
-
-      - id: warning_update_dockerfile
-        type: Alert
-        properties:
-          type: warning
-          icon: AiFilledWarning
-          description: When updating your app to a new Lowdefy version, make sure to update the Lowdefy version in the Dockerfile
-
-      - id: md2
-        type: Markdown
-        properties:
-          content: |
-            ### Step 2 - Create a `.dockerignore` file
-
-            Create a file called `.dockerignore` in your project repository:
-
-            ```
-            .lowdefy/**
-            .serverless/**
-            .env
-            ```
-
-            ### Step 3 - Create a serverless.yaml file
-
-            Create a file called `serverless.yaml` in your project repository:
-
-            ```
-            service: lowdefy-example-aws-lambda
-            frameworkVersion: '2'
-            provider:
-              name: aws
-              region: us-east-1
-              ecr:
-                images:
-                  lowdefy:
-                    path: .
-                    file: Dockerfile
-
-            functions:
-              lowdefy-server:
-                image: lowdefy
-                name: lowdefy-example-aws-lambda-${opt:stage}
-                # Set secrets as environment variables here
-                # environment:
-                #   LOWDEFY_SECRET_MY_SECRET: ${env:LOWDEFY_SECRET_MY_SECRET}
-
-                events:
-                  - httpApi: '*'
-            ```
-
-            ### Step 4 - Deploy to AWS
-
-            Deploy to AWS by running:
-
-            ```
-            npx serverless deploy --verbose --conceal --stage dev
-            ```

package/deployment/docker.yaml

@@ -1,118 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: docker
-    pageTitle: Deploy with Docker
-    section: Deployment
-    filePath: deployment/docker.yaml
-    content:
-      - id: md1
-        type: Markdown
-        properties:
-          content: |
-            The [official Lowdefy Docker](https://hub.docker.com/repository/docker/lowdefy/lowdefy) images can be found on Docker Hub.
-
-            Examples of Docker configuration can be found in the [example repository](https://github.com/lowdefy/lowdefy-example-docker).
-
-            The Lowdefy Docker images contain a Lowdefy server. The configuration of the Lowdefy app can either be built into a new image based on the Lowdefy image, or the configuration read from the file system, usually provided as a volume.
-
-            The Lowdefy server can be configured using the following environment variables:
-
-            - `LOWDEFY_BASE_PATH`: Set the base path to serve the Lowdefy application from. This will serve the application under `https://example.com/<base-path>`instead of `https://example.com`,  and all pages under `https://example.com/<base-path>/<page-id>` instead of the default `https://example.com/<page-id>`.
-            - `LOWDEFY_SERVER_BUILD_DIRECTORY`: The directory of the built Lowdefy configuration (The output of `lowdefy build`, usually found at `./.lowdefy/build` in your project repository). The default is `./build` (or `/home/node/lowdefy/build`).
-            - `LOWDEFY_SERVER_PUBLIC_DIRECTORY`: The directory of the public assets to be served. The default is `./public` (or `/home/node/lowdefy/public`).
-            - `LOWDEFY_SERVER_PORT`: The port (inside the container) at which to run the server. The default is `3000`.
-
-      - id: warning_update_dockerfile
-        type: Alert
-        properties:
-          type: warning
-          icon: AiFilledWarning
-          description: When updating your app to a new Lowdefy version, make sure to update the Lowdefy version in the Dockerfile
-
-      - id: md2
-        type: Markdown
-        properties:
-          content: |
-            # Building a Lowdefy app image
-
-            To build the configuration into an image, the following Dockerfile can be used:
-            ```text
-            FROM node:14-buster AS build
-
-            # Set working directory and node user
-            WORKDIR /home/node/lowdefy
-
-            RUN chown node:node /home/node/lowdefy
-
-            USER node
-
-            # Copy app config and change ownership of files to "node" user
-            COPY  --chown=node:node  . .
-
-            # Build the Lowdefy config using the Lowdefy CLI
-            RUN npx lowdefy@3.23.2 build
-
-            # Use the correct Lowdefy base image
-            FROM lowdefy/lowdefy:3.23.2
-
-            # Copy build output from build stage
-            COPY --from=build --chown=node:node /home/node/lowdefy/.lowdefy/build ./build
-
-            # Copy contents of public directory into image
-            COPY --chown=node:node ./public ./public
-
-            # Run the server on start
-            CMD ["node", "./dist/server.js"]
-            ```
-
-            with a `.dockerignore` file:
-
-            ```
-            .lowdefy/**
-            .env
-            ```
-
-            An image can be built by running:
-            ```
-            docker build -t <tag> .
-            ```
-
-            The container can be run by:
-            ```
-            docker run -p 3000:3000 <tag>
-            ```
-
-            Docker compose can also be used. Use a `docker-compose.yaml` file:
-            ```
-            version: "3.8"
-            services:
-              lowdefy:
-                build: .
-                ports:
-                  - "3000:3000"
-            ```
-
-            To build the image, run:
-            ```
-            docker compose build
-            ```
-
-            To run the app, run:
-            ```
-            docker compose up
-            ```

package/deployment/netlify.yaml

@@ -1,69 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: netlify
-    pageTitle: Deploy to Netlify
-    section: Deployment
-    filePath: deployment/netlify.yaml
-    content:
-      - id: md1
-        type: MarkdownWithCode
-        properties:
-          content: |
-            Lowdefy apps can be deployed to [Netlify](https://www.netlify.com). Netlify integrates with git providers to automatically deploy your app when you merge changes into the main branch of your repository and deploy previews of pull requests. On your Netlify deployment you can set environment variables, manage custom domains and more.
-
-            ## How to Deploy to Netlify
-
-            #### Step 1
-
-            Your project will need to be hosted as a Github repository.
-
-            #### Step 2
-
-            Link your Github project to Netlify.
-
-            - Once logged in to Netlify, click the "New site from git" button.
-            - Choose Github, and authorize Netlify to access your repositories.
-            - Select your repository.
-
-            > If your repository isn't found, click "Configure Netlify on Github", and give Netlify access to your repository.
-
-            #### Step 3
-
-            Configure your Netlify deployment.
-
-            - Set your build command to `npx lowdefy@3 build-netlify`.
-            - Set your publish directory to `.lowdefy/publish`.
-
-            #### Step 4
-
-            Configure the Lowdefy server.
-
-            - Click the "Advanced build settings" button.
-            - Set the functions directory to `.lowdefy/functions`.
-
-            #### Step 5
-
-            Deploy your site.
-
-            - Click "Deploy site"
-
-            On the "Site overview" tab you will find your site url.
-
-            #### Step 6
-
-            To set Lowdefy secrets, go to "Site settings", then "Build and deploy" in the left menu. Scroll down and select "Edit variables" in the "Environment" section. Here you can set the `LOWDEFY_SECRET_` environment variables.

package/deployment/node-server.yaml

@@ -1,111 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: node-server
-    pageTitle: Deploy with Node.js
-    section: Deployment
-    filePath: deployment/node-server.yaml
-    content:
-      - id: md1
-        type: Markdown
-        properties:
-          content: |
-            A production Lowdefy server that runs using Node.js is published on npm as [@lowdefy/server-node](https://www.npmjs.com/package/@lowdefy/server-node).
-
-            ## Running the server
-
-            ### Step 1 - Create a `package.json` file
-
-            To run the server in a Lowdefy project, first initialise a Node.js project by creating a `package.json` file in the root of your project. To do this, you can run
-
-            ```
-            npm init
-            ```
-
-            ### Step 2 - Add the `@lowdefy/server-node` package to your project as a dependency
-
-            To add the server as a dependency, run
-
-            ```
-            npm install @lowdefy/server-node --save --save-exact
-            ```
-
-            ### Step 3 - Add the Lowdefy CLI to you project as a dev dependency.
-
-            To add the server as a dependency, run:
-
-            ```
-            npm install lowdefy --save-dev --save-exact
-            ```
-
-            ### Step 4 - Add the `build` and `start` scripts.
-
-            Add the following to the `scripts` section in your `package.json` file:
-
-            ```json
-            "scripts": {
-              "init": "lowdefy init",
-              "build": "lowdefy build",
-              "start": "lowdefy-server"
-            },
-            ```
-
-            ### Step 5 - Init a Lowdefy project
-
-            Run:
-
-            ```
-            npm run init
-            ```
-
-            ### Step 6 - Add the public files:
-
-            Create a folder called `public` in your project directory and add the Lowdefy public files found [here](https://github.com/lowdefy/lowdefy/tree/main/packages/shell/src/public) (or add your own logos and files).
-
-            ### Step 7 - Build the Lowdefy project
-
-            Build the Lowdefy configuration files in the project by running:
-
-            ```
-            npm run build
-            ```
-
-            ### Step 8 - Start the server
-
-            To start the server, run:
-
-            ```
-            npm run start
-            ```
-
-            ## Configuration
-
-            The Lowdefy server can be configured using command-line arguments or environment variables. The command-line arguments take precedence over the environment variables.
-
-            The following command-line arguments can be specified:
-
-            - `--build-directory`: The directory of the built Lowdefy configuration (The output of `lowdefy build`, usually found at `./.lowdefy/build` in your project repository). The default is `./.lowdefy/build`.
-            - `--port`: The port at which to run the server. The default is `3000`.
-            - `--public-directory`: The directory of the public assets to be served. The default is `./public`.
-
-
-            The following environment variables can be specified:
-
-            - `LOWDEFY_BASE_PATH`: Set the base path to serve the Lowdefy application from. This will serve the application under `https://example.com/<base-path>`instead of `https://example.com`,  and all pages under `https://example.com/<base-path>/<page-id>` instead of the default `https://example.com/<page-id>`.
-            - `LOWDEFY_SERVER_BUILD_DIRECTORY`: The directory of the built Lowdefy configuration (The output of `lowdefy build`, usually found at `./.lowdefy/build` in your project repository). The default is `./.lowdefy/build`.
-            - `LOWDEFY_SERVER_PORT`: The port at which to run the server. The default is `3000`.
-            - `LOWDEFY_SERVER_PUBLIC_DIRECTORY`: The directory of the public assets to be served. The default is `./public`.

package/head.html

@@ -1,7 +0,0 @@
-<script type="module" src="/public/modules/index.js"></script>
-<link
-  rel="stylesheet"
-  href="https://cdn.jsdelivr.net/npm/docsearch.js@2.6.3/dist/cdn/docsearch.min.css"
-/>
-<script defer type="module" src="/public/modules/pdfMake.js"></script>
-<script defer type="module" src="/public/modules/csvMake.js"></script>