content
stringlengths 14
222
|
|---|
<s>utube""~k":"42x"}]"~k":"420"}"~k":"41z"}"~k":"41x"}]"~k":"41u"}"~k":"41t"}"~k":"41l"}{"id":"block:tutorial-start:footer_cta_box:0""type":"Box""layout":{"span":12"align":"middle""~k":"435"}<s> |
<s>"blockId":"footer_cta_box""areas":{"content":{"blocks":[{"id":"block:tutorial-start:footer_cta:0""type":"Title""visible":{"_not":{"_global":"newsletter_subscribed""~k":"43a"}"~k":"439"}"style":<s> |
<s>{"textAlign":"center""~k":"43b"}"properties":{"content":"Subscribe to our newsletter""level":3"color":"#1990FF""~k":"43c"}"blockId":"footer_cta""~k":"438"}{"id":"block:tutorial-start:footer_ct<s> |
<s>a_paragraph:0""type":"Paragraph""visible":{"_not":{"_global":"newsletter_subscribed""~k":"43f"}"~k":"43e"}"style":{"textAlign":"center""~k":"43g"}"properties":{"content":"Receive the latest Low<s> |
<s>defy updates in your inbox.""~k":"43h"}"blockId":"footer_cta_paragraph""~k":"43d"}{"id":"block:tutorial-start:footer_cta_box:1""type":"Box""layout":{"contentGutter":[120]"contentJustify":"cent<s> |
<s>er""~k":"43j"}"blockId":"footer_cta_box""areas":{"content":{"blocks":[{"id":"block:tutorial-start:email:0""type":"TextInput""visible":{"_not":{"_global":"newsletter_subscribed""~k":"43o"}"~k":"<s> |
<s>43n"}"layout":{"flex":"0 1 250px""~k":"43p"}"validate":[{"message":"Please provide a valid email address.""status":"error""pass":{"_regex":"^(([^\u003c\u003e()\\[\\]\\\\.;:\\s@\"]+(\\.[^\u003c\u<s> |
<s>003e()\\[\\]\\\\.;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{13}\\.[0-9]{13}\\.[0-9]{13}\\.[0-9]{13}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2}))$""~k":"43r"}"~k":"43q"}]"properties":{"size":"large""placeho<s> |
<s>lder":"Enter your email""label":{"disabled":true"~k":"43t"}"~k":"43s"}"blockId":"email""~k":"43m"}{"id":"block:tutorial-start:footer_cta_button:0""type":"Button""visible":{"_not":{"_global":"n<s> |
<s>ewsletter_subscribed""~k":"43w"}"~k":"43v"}"layout":{"flex":"0 1 auto""~k":"43x"}"properties":{"title":"Subscribe""size":"large""~k":"43y"}"events":{"onClick":{"try":[{"id":"validate""type":"<s> |
<s>Validate""params":"email""~k":"441"}{"id":"post_data""type":"Request""params":["insert_newsletter""discord_message_newsletter"]"messages":{"success":"Thanks for subscribing!""~k":"443"}"~k":"<s> |
<s>442"}{"id":"set_subscribed""type":"SetGlobal""params":{"newsletter_subscribed":true"~k":"445"}"~k":"444"}]"catch":[]"~k":"440"}"~k":"43z"}"blockId":"footer_cta_button""~k":"43u"}{"id":"bloc<s> |
<s>k:tutorial-start:subscribed_thank_you:0""type":"Alert""layout":{"flex":"0 1 350px""~k":"447"}"visible":{"_not":{"_not":{"_global":"newsletter_subscribed""~k":"44a"}"~k":"449"}"~k":"448"}"prope<s> |
<s>rties":{"message":"Thanks! 馃憦 We'll keep you updated with the latest Lowdefy news.""type":"success""~k":"44b"}"blockId":"subscribed_thank_you""~k":"446"}]"~k":"43l"}"~k":"43k"}"~k":"43i"}]"~k"<s> |
<s>:"437"}"~k":"436"}"~k":"434"}{"id":"block:tutorial-start:footer_links:0""type":"Box""layout":{"span":6"contentGutter":8"~k":"44d"}"blockId":"footer_links""areas":{"content":{"blocks":[{"id":"<s> |
<s>block:tutorial-start:why_anchor:0""type":"Anchor""properties":{"title":"Why Lowdefy""url":"https://lowdefy.com""rel":"noopener""~k":"44h"}"blockId":"why_anchor""~k":"44g"}{"id":"block:tutorial<s> |
<s>-start:tutorial_anchor:0""type":"Anchor""properties":{"title":"Quick Start Tutorial""pageId":"tutorial-development-server""rel":"noopener""~k":"44j"}"blockId":"tutorial_anchor""~k":"44i"}{"id"<s> |
<s>:"block:tutorial-start:netlify_anchor:0""type":"Anchor""properties":{"title":"Deploy to Netlify""pageId":"tutorial-start""rel":"noopener""~k":"44l"}"blockId":"netlify_anchor""~k":"44k"}{"id":"<s> |
<s>block:tutorial-start:concepts_anchor:0""type":"Anchor""properties":{"title":"How Lowdefy Works""pageId":"overview""rel":"noopener""~k":"44n"}"blockId":"concepts_anchor""~k":"44m"}{"id":"block:<s> |
<s>tutorial-start:github_anchor:0""type":"Anchor""properties":{"title":"Github Repository""url":"https://github.com/lowdefy/lowdefy""newTab":true"~k":"44p"}"blockId":"github_anchor""~k":"44o"}{"i<s> |
<s>d":"block:tutorial-start:changelog_anchor:0""type":"Anchor""properties":{"title":"Version Changelog""url":"https://github.com/lowdefy/lowdefy/blob/main/CHANGELOG.md""newTab":true"~k":"44r"}"bloc<s> |
<s>kId":"changelog_anchor""~k":"44q"}{"id":"block:tutorial-start:license_anchor:0""type":"Anchor""properties":{"title":"Apache-2.0 License""url":"https://github.com/lowdefy/lowdefy/blob/main/LICENSE<s> |
<s>""newTab":true"~k":"44t"}"blockId":"license_anchor""~k":"44s"}]"~k":"44f"}"~k":"44e"}"~k":"44c"}{"id":"block:tutorial-start:footer_logo_box_sm:0""type":"Box""visible":{"_or":[{"_eq":[{"_medi<s> |
<s>a":"size""~k":"44x"}"sm"]"~k":"44w"}{"_eq":[{"_media":"size""~k":"44z"}"xs"]"~k":"44y"}]"~k":"44v"}"layout":{"contentJustify":"center""~k":"450"}"blockId":"footer_logo_box_sm""areas":{"con<s> |
<s>tent":{"blocks":[{"id":"block:tutorial-start:footer_logo:1""type":"Html""properties":{"html":"\u003cp style=\"text-align: center;\"\u003e\u003ca href=\"https://lowdefy.com\" ref=\"noopener\"\u003e\u<s> |
<s>003cimg src=\"/logo-light-theme.png\" width=\"126px\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\u003cp style=\"text-align: center; font-size: 0.85rem;\" \u003eBuild internal tools with YAML.\u003c/p\u003e<s> |
<s>\n\u003cp style=\"text-align: center;\"\u003e\u003ca href=\"mailto:hello@lowdefy.com\"\u003ehello@lowdefy.com\u003c/a\u003e\u003c/p\u003e\n""~k":"454"}"blockId":"footer_logo""~k":"453"}{"id":"bloc<s> |
<s>k:tutorial-start:community_links:1""type":"Box""layout":{"contentJustify":"space-around""size":200"~k":"456"}"blockId":"community_links""areas":{"content":{"blocks":[{"id":"block:tutorial-start:<s> |
<s>lowdefy_twitter:1""type":"Icon""layout":{"size":"auto""~k":"45a"}"properties":{"name":"AiOutlineTwitter""size":24"~k":"45b"}"events":{"onClick":{"try":[{"id":"link_twitter""type":"Link""param<s> |
<s>s":{"url":"https://twitter.com/lowdefy""newTab":true"~k":"45f"}"~k":"45e"}]"catch":[]"~k":"45d"}"~k":"45c"}"blockId":"lowdefy_twitter""~k":"459"}{"id":"block:tutorial-start:lowdefy_community:<s> |
<s>1""type":"Icon""layout":{"size":"auto""~k":"45h"}"properties":{"name":"AiOutlineComment""size":24"~k":"45i"}"events":{"onClick":{"try":[{"id":"link_community""type":"Link""params":{"url":"htt<s> |
<s>ps://github.com/lowdefy/lowdefy/discussions""newTab":true"~k":"45m"}"~k":"45l"}]"catch":[]"~k":"45k"}"~k":"45j"}"blockId":"lowdefy_community""~k":"45g"}{"id":"block:tutorial-start:lowdefy_git<s> |
<s>hub:1""type":"Icon""layout":{"size":"auto""~k":"45o"}"properties":{"name":"AiOutlineGithub""size":24"~k":"45p"}"events":{"onClick":{"try":[{"id":"link_github""type":"Link""params":{"url":"htt<s> |
<s>ps://github.com/lowdefy/lowdefy""newTab":true"~k":"45t"}"~k":"45s"}]"catch":[]"~k":"45r"}"~k":"45q"}"blockId":"lowdefy_github""~k":"45n"}{"id":"block:tutorial-start:lowdefy_youtube:1""type":<s> |
<s>"Icon""layout":{"size":"auto""~k":"45v"}"properties":{"name":"AiOutlineYoutube""size":24"~k":"45w"}"events":{"onClick":{"try":[{"id":"link_youtube""type":"Link""params":{"url":"https://www.you<s> |
<s>tube.com/channel/UCQLUr15MfP_9yGSO5dmf9wg""newTab":true"~k":"460"}"~k":"45z"}]"catch":[]"~k":"45y"}"~k":"45x"}"blockId":"lowdefy_youtube""~k":"45u"}]"~k":"458"}"~k":"457"}"~k":"455"}]"~k":<s> |
<s>"452"}"~k":"451"}"~k":"44u"}{"id":"block:tutorial-start:lowdefy_cc_box:0""type":"Box""blockId":"lowdefy_cc_box""areas":{"content":{"blocks":[{"id":"block:tutorial-start:lowdefy_cc:0""type":"Htm<s> |
<s>l""properties":{"html":"\u003cdiv style=\"text-align: center; font-size: 12px; margin-top: 42px;\"\u003e漏 2023 Lowdefy Inc. - Give. Easy. Value.\u003c/div\u003e\n""~k":"465"}"blockId":"lowdefy_cc"<s> |
<s>"~k":"464"}]"~k":"463"}"~k":"462"}"~k":"461"}]"~k":"41k"}"~k":"41j"}"~k":"41g"}]"~k":"3xi"}"content":{"justify":"center""blocks":[{"id":"block:tutorial-start:max_width:0""type":"Box""layou<s> |
<s>t":{"flex":"0 1 800px""~k":"468"}"blockId":"max_width""areas":{"content":{"blocks":[{"id":"block:tutorial-start:page_title:0""type":"Title""properties":{"content":"1. Getting started""~k":"46c"}<s> |
<s>"blockId":"page_title""~k":"46b"}{"id":"block:tutorial-start:content:0""type":"Box""layout":{"contentGutter":16"~k":"46e"}"blockId":"content""areas":{"content":{"blocks":[{"id":"block:tutorial<s> |
<s>-start:body_start:0""type":"MarkdownWithCode""properties":{"content":"In this tutorial we will be creating a simple ticketing app that allows users to file new tickets and see a list of outstanding<s> |
tickets. The app reads product data from [DummyJSON](https://dummyjson.com/) and will write the ticket data to an [SQLite](https://www.sqlite.org/) database.\n\n### Requirements\n\nThe Lowdefy CLI (C |
<s>ommand Line Interface) is needed to run the development server. To run the Lowdefy CLI you need to install Node.js at version 16 or greater. If you don't have it installed download Node.js from https<s> |
<s>://nodejs.org/en/download/ and follow the installation steps for your computer. All of the default settings given by the installer are fine for what we need. You will also need a text editor to modif<s> |
<s>y the Lowdefy configuration files.\n\nLowdefy also requires [`pnpm`](https://pnpm.io/) to be installed. We recommend making activating [Corepack](https://nodejs.org/api/corepack.html) even though it <s> |
<s>is an experimental feature as this is the simplest way to install `pnpm`. Alternative methods to install `pnpm` can also be found [here](https://pnpm.io/installation). To activate Corepack run the f<s> |
<s>ollowing in your computer's command line interface (Windows CMD Terminal on MacOS).\n""~k":"46i"}"blockId":"body_start""~k":"46h"}{"id":"block:tutorial-start:command_box_corepack_enable:0""type"<s> |
<s>:"Box""style":{"backgroundColor":"#f7f7f7""borderColor":"#c1c8cc""borderStyle":"solid""borderWidth":"1px""~k":"46k"}"blockId":"command_box_corepack_enable""areas":{"content":{"blocks":[{"id":"b<s> |
<s>lock:tutorial-start:command_run_corepack_enable:0""type":"Paragraph""layout":{"flex":"0 1 auto""~k":"46o"}"style":{"marginRight":"6px""marginLeft":"16px""marginTop":"16px""~k":"46p"}"propertie<s> |
<s>s":{"content":"$""~k":"46q"}"blockId":"command_run_corepack_enable""~k":"46n"}{"id":"block:tutorial-start:command_corepack_enable:0""type":"Paragraph""layout":{"flex":"0 1 auto""~k":"46s"}"pro<s> |
<s>perties":{"style":{"marginTop":"16px""~k":"46u"}"code":true"copyable":{"icon":"AiOutlineCopy""tooltips":["Click to copy""Copied. Paste in console to run 馃殌"]"~k":"46v"}"content":"corepack enable<s> |
<s>""~k":"46t"}"blockId":"command_corepack_enable""~k":"46r"}]"~k":"46m"}"~k":"46l"}"~k":"46j"}{"id":"block:tutorial-start:body_yaml_files:0""type":"MarkdownWithCode""properties":{"content":"###<s> |
<s>## YAML files\n\nIf you don't have any experience using YAML please familiarize yourself YAML before continuing.\n\n[This video is a good introduction to YAML.](https://www.youtube.com/embed/cdLNKUoM<s> |
<s>c6c?origin=https://docs.lowdefy.com)\n\nLowdefy apps are written using YAML files. YAML files are useful for storing structured data like the configuration of all of the elements of your app. YAML fi<s> |
<s>les focus on being easily readable by humans this means they don't use lots of syntactic elements like brackets that make it difficult for humans to read but instead use __indentation to indicate st<s> |
<s>ructure__. While this does make the file easier to read this means care has to be taken that the data structure is as you intended.\n\n\u003e Lowdefy apps can also be defined using JSON files or a m<s> |
ix of YAML and JSON. We find YAML files more convenient to write.\n\n#### 1.1. Create a project directory\n\nCreate a directory (folder) on your computer where you would like to create the configurati |
on files for your project. We will be referring to this directory as the project directory.\n\n#### 1.2. Open a command line interface\n\nOpen your computer's command line interface and change directo |
<s>ry (`cd`) to the project directory.\n\n#### 1.3. Initialize an app\n\nUse the Lowdefy CLI to initialize your project. We recommend using [`pnpx`](https://pnpm.io/6.x/pnpx-cli) to run the Lowdefy CLI <s> |
<s>since this will always run the latest version of the CLI.\n\nRun the following in your terminal:\n""~k":"46x"}"blockId":"body_yaml_files""~k":"46w"}{"id":"block:tutorial-start:command_box_init:0"<s> |
<s>"type":"Box""style":{"backgroundColor":"#f7f7f7""borderColor":"#c1c8cc""borderStyle":"solid""borderWidth":"1px""~k":"46z"}"blockId":"command_box_init""areas":{"content":{"blocks":[{"id":"block:<s> |
<s>tutorial-start:command_run_init:0""type":"Paragraph""layout":{"flex":"0 1 auto""~k":"473"}"style":{"marginRight":"6px""marginLeft":"16px""marginTop":"16px""~k":"474"}"properties":{"content":"$<s> |
<s>""~k":"475"}"blockId":"command_run_init""~k":"472"}{"id":"block:tutorial-start:command_init:0""type":"Paragraph""layout":{"flex":"0 1 auto""~k":"477"}"properties":{"style":{"marginTop":"16px"<s> |
<s>"~k":"479"}"code":true"copyable":{"icon":"AiOutlineCopy""tooltips":["Click to copy""Copied. Paste in console to run 馃殌"]"~k":"47a"}"content":"pnpx lowdefy@rc init""~k":"478"}"blockId":"command_<s> |
<s>init""~k":"476"}]"~k":"471"}"~k":"470"}"~k":"46y"}{"id":"block:tutorial-start:body_init:0""type":"MarkdownWithCode""properties":{"content":"This will create two files in your current working di<s> |
<s>rectory. The first file called `lowdefy.yaml` is the starting point of your app's configuration. The second called `.gitignore` is a hidden file that tells `git` a version control tool not to ver<s> |
<s>sion or upload some specific files.\n\n\u003e __Error: A \"lowdefy.yaml\" file already exists__: Try running the command in a new directory or consider deleting the _lowdefy.yaml_ file in your current<s> |
<s> working directory.\n""~k":"47c"}"blockId":"body_init""~k":"47b"}{"id":"block:tutorial-start:body_start_dev:0""type":"MarkdownWithCode""properties":{"content":"#### 1.4. Start the development se<s> |
<s>rver\n\nRun:\n""~k":"47e"}"blockId":"body_start_dev""~k":"47d"}{"id":"block:tutorial-start:command_box_dev:0""type":"Box""style":{"backgroundColor":"#f7f7f7""borderColor":"#c1c8cc""borderStyle<s> |
<s>":"solid""borderWidth":"1px""~k":"47g"}"blockId":"command_box_dev""areas":{"content":{"blocks":[{"id":"block:tutorial-start:command_run_dev:0""type":"Paragraph""layout":{"flex":"0 1 auto""~k":"<s> |
<s>47k"}"style":{"marginRight":"6px""marginLeft":"16px""marginTop":"16px""~k":"47l"}"properties":{"content":"$""~k":"47m"}"blockId":"command_run_dev""~k":"47j"}{"id":"block:tutorial-start:comman<s> |
<s>d_dev:0""type":"Paragraph""layout":{"flex":"0 1 auto""~k":"47o"}"properties":{"style":{"marginTop":"16px""~k":"47q"}"code":true"copyable":{"icon":"AiOutlineCopy""tooltips":["Click to copy""Co<s> |
<s>pied. Paste in console to run 馃殌"]"~k":"47r"}"content":"pnpx lowdefy@rc dev""~k":"47p"}"blockId":"command_dev""~k":"47n"}]"~k":"47i"}"~k":"47h"}"~k":"47f"}{"id":"block:tutorial-start:body_open<s> |
<s>_browser:0""type":"MarkdownWithCode""properties":{"content":"Your browser should open on http://localhost:3000 and you should see the following:\n""~k":"47t"}"blockId":"body_open_browser""~k":"4<s> |
<s>7s"}{"id":"block:tutorial-start:example1:0""type":"PageHeaderMenu""properties":{"style":{"minHeight":"300px""~k":"47w"}"menu":{"links":[{"id":"welcome""type":"MenuLink""properties":{"title":"we<s> |
<s>lcome""~k":"47z"}"~k":"47y"}]"~k":"47x"}"~k":"47v"}"blockId":"example1""areas":{"content":{"blocks":[{"id":"block:tutorial-start:content_card:0""type":"Card""areas":{"content":{"blocks":[{"id"<s> |
<s>:"block:tutorial-start:content:1""type":"Result""properties":{"title":"Welcome to your Lowdefy app""subTitle":"We are excited to see what you are going to build""status":"success""icon":{"name":"<s> |
<s>AiOutlineHeart""color":"#f00""~k":"487"}"~k":"486"}"areas":{"extra":{"blocks":[{"id":"block:tutorial-start:docs_button:0""type":"Button""properties":{"size":"large""title":"Let's build somethin<s> |
<s>g""~k":"48b"}"events":{"onClick":{"try":[{"id":"link_to_docs""type":"Link""params":{"url":"https://docs.lowdefy.com""newTab":true"~k":"48f"}"~k":"48e"}]"catch":[]"~k":"48d"}"~k":"48c"}"bloc<s> |
<s>kId":"docs_button""~k":"48a"}]"~k":"489"}"~k":"488"}"blockId":"content""~k":"485"}]"~k":"484"}"footer":{"blocks":[{"id":"block:tutorial-start:footer:0""type":"Paragraph""properties":{"type":"<s> |
<s>secondary""content":"Made by a Lowdefy 馃\n""~k":"48i"}"blockId":"footer""~k":"48h"}]"~k":"48g"}"~k":"483"}"blockId":"content_card""~k":"482"}]"~k":"481"}"~k":"480"}"~k":"47u"}{"id":"block:<s> |
<s>tutorial-start:body_error_ldf_file:0""type":"MarkdownWithCode""properties":{"content":"\u003e __Error: Could not find \"lowdefy.yaml\"__: Make sure your current working directory contains the _lowde<s> |
<s>fy.yaml_ file. You can verify this by running the `dir` (Windows) or `ls` (MacOS) command.\n""~k":"48k"}"blockId":"body_error_ldf_file""~k":"48j"}{"id":"block:tutorial-start:body_edit:0""type":"M<s> |
<s>arkdownWithCode""properties":{"content":{"_nunjucks":{"on":{"version":"4.0.0-rc.10""~k":"48p"}"template":"#### 1.5. Open the configuration file\n\nOpen the `lowdefy.yaml` file using a text editor l<s> |
ike [VS Code](https://code.visualstudio.com/download). The content of the file should look like this:\n\n```yaml\nlowdefy: {{ version }}\nname: Lowdefy starter\n\npages:\n - id: welcome\n type: Pa |
geHeaderMenu\n properties:\n title: Welcome\n areas:\n content:\n justify: center\n blocks:\n - id: content_card\n type: Card\n style:\n |
maxWidth: 800\n blocks:\n - id: content\n type: Result\n properties:\n title: Welcome to your Lowdefy app\n |
subTitle: We are excited to see what you are going to build\n icon:\n name: AiOutlineHeart\n color: '#f00'\n areas:\n |
extra:\n blocks:\n - id: docs_button\n type: Button\n properties:\n size: lar |
ge\n title: Let's build something\n events:\n onClick:\n - id: link_to_docs\n |
type: Link\n params:\n url: https://docs.lowdefy.com\n newWindow: true\n footer:\n blocks: |
\n - id: footer\n type: Paragraph\n properties:\n type: secondary\n content: |\n Made by a Lowdefy 馃\n```\n\nThis configuration |
<s>completely describes the app you are running.\n\n#### 1.6. Make some changes\n\nLet's modify the button to link to the Lowdefy Discord community instead of to the Lowdefy docs.\n\nFirst change `Let's<s> |
<s> build something` to `Join Lowdefy on Discord` then save the file. Your page should automatically refresh and you should see the changed text of the button.\n\nNext update the link url to the Lowdef<s> |
<s>y Discord link replace `https://docs.lowdefy.com` with [`https://discord.gg/QQY9eJ7A2D`](https://discord.gg/QQY9eJ7A2D) then save the file. If you now click the button it should open a new window li<s> |
<s>nking to the Lowdefy Discord Channel - Join our community to ask questions or learn more regarding Lowdefy 鉂わ笍\n""~k":"48o"}"~k":"48n"}"~k":"48m"}"blockId":"body_edit""~k":"48l"}{"id":"block:tuto<s> |
<s>rial-start:body_what_happened:0""type":"Markdown""properties":{"content":"### What happened\n\nThe Lowdefy CLI helps you develop a Lowdefy app.\n\nWe used the `pnpx lowdefy@rc init` command to initi<s> |
alize a new project. This created all the essential files.\n\nWe also used the `pnpx lowdefy@rc dev` command to start a development server. The development server runs a Lowdefy app locally on your co |
<s>mputer which can be accessed at http://localhost:3000. The development server watches your configuration files and if any of them changes it \"builds\" (compiles the configuration together for the s<s> |