|
1 |
| -> Codespaces unavailable - please use [Express Install](Install-Express.md). |
2 |
| -
|
3 |
| -The fastest way to explore API Logic Server - *with __no install__* - is to follow this guide to create, explore and customize a project using Codespaces. |
4 |
| - |
5 |
| -<details markdown> |
6 |
| - |
7 |
| -<summary>What is API Logic Server</summary> |
8 |
| - |
9 |
| -API Logic Server creates __customizable database web app projects:__ |
10 |
| - |
11 |
| -* Creation is __Instant:__ create _executable_ projects from your database, with a _single_ command. Projects are __Highly Functional,__ providing: |
12 |
| - |
13 |
| - * __API:__ an endpoint for each table, with filtering, sorting, pagination and related data access |
14 |
| - |
15 |
| - * __Admin UI:__ multi-page / multi-table apps, with page navigations, automatic joins and declarative hide/show |
16 |
| - |
17 |
| -* __Projects are Customizable, using _your IDE_:__ such as VSCode, PyCharm, etc, for familiar edit/debug services |
18 |
| - |
19 |
| -* __Business Logic Automation:__ using unique spreadsheet-like rules, customizable with Python :trophy: |
20 |
| - |
21 |
| -Follow the steps below to be up and running in about a minute - no install, no configuration. You can run the created project to explore its functionality, and how to customize it in VSCode. |
22 |
| - |
23 |
| - |
24 |
| - |
25 |
| -<details markdown> |
26 |
| - |
27 |
| -<summary>Why Does It Matter: Faster, Simpler, Modern Architecture</summary> |
28 |
| - |
29 |
| -<details markdown> |
30 |
| - |
31 |
| -<summary>Frameworks are too slow, Low Code is not dev-friendly</summary> |
32 |
| - |
33 |
| -We looked at approaches for building database systems: |
34 |
| - |
35 |
| -* __Frameworks:__ Frameworks like Flask or Django enable you to build a single endpoint or _Hello World_ page, but a __multi-endpoint__ API and __multi-page__ application would take __weeks__ or more. |
36 |
| - |
37 |
| -* __Low Code Tools:__ these are great for building great UIs, but |
38 |
| - |
39 |
| - * Want a multi-page app, _instantly_ -- __no layout required each screen__ |
40 |
| - * Want to __preserve standard dev tools__ (VSCode, PyCharm, git, etc) - propietary IDEs are not dev-friendly |
41 |
| - |
42 |
| -And neither provides an answer for __backend business logic__ (it's nearly half the effort). |
43 |
| - |
44 |
| -</details> |
45 |
| - |
46 |
| -<details markdown> |
47 |
| - |
48 |
| -<summary>API Logic Server - dev-friendly low-code automation</summary> |
49 |
| - |
50 |
| - |
51 |
| -API Logic Server is a low-code, developer-friendly approach that leverages automation to dramatically improve web app development: |
52 |
| - |
53 |
| -* Automation makes it __faster:__ _moments_, instead of weeks or months. Unblock UI Dev, and engage business users - _early_ - to reduce misunderstandings. _Customize_ with __standard IDEs.__ |
54 |
| - |
55 |
| -* Automation makes it __simpler:__ this reduces the risk of architectural errors, e.g., APIs without pagination. |
56 |
| - |
57 |
| -* Automation ensures a __modern software architecture:__ _container-ready_, _API-based_, with _shared logic_ over UIs and APIs (no more logic in UI controllers), in maintainable _models_. |
58 |
| - |
59 |
| -</details> |
60 |
| - |
61 |
| -</details> |
62 |
| - |
63 |
| -</details> |
64 |
| - |
65 |
| - |
66 |
| - |
67 |
| - |
68 |
| - |
69 |
| -## 1. Open in Codespaces |
70 |
| - |
71 |
| -No install is required - this runs in the cloud, via your Browser, courtesy Codespaces. Use your existing GitHub account (no signup is required), and: |
72 |
| - |
73 |
| -1. [__Click here__](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=593459232){:target="_blank" rel="noopener"} to open the *Create Codespace* page. |
74 |
| - |
75 |
| -2. Configure as desired, and click __Create codespace__. |
76 |
| - |
77 |
| -> This process takes about a minute. Wait until you see the port created. |
78 |
| -
|
79 |
| -<details markdown> |
80 |
| - |
81 |
| -<summary>What Is Happening</summary> |
82 |
| - |
83 |
| -You will now see 3 projects - open in VSCode, _in the Browser._ But that's just what you _see..._ |
84 |
| - |
85 |
| -Behind the scenes, Codespaces has requisitioned a cloud machine, and loaded the template - with a _complete development environment_ - Python, your dependencies, git, etc. |
86 |
| - |
87 |
| -You are attached to this machine in your Browser, running VSCode. |
88 |
| - |
89 |
| -These instructions are now visible in VS Code, to minimize window switching. |
90 |
| - |
91 |
| - |
92 |
| -> :trophy: Pretty remarkable. |
93 |
| -
|
94 |
| -</details> |
95 |
| - |
96 |
| -<details markdown> |
97 |
| - |
98 |
| -<summary>Verify it worked</summary> |
99 |
| - |
100 |
| -VSCode will open in your Browser, and the project will perform various initialization tasks. After about 1 minute, verify as follows: |
101 |
| - |
102 |
| -1. Port is created |
103 |
| -2. Port made public |
104 |
| -3. 3 Sample projects created |
105 |
| -3. `readme` opened, showing next step |
106 |
| - |
107 |
| - |
108 |
| - |
109 |
| -</details> |
110 |
| - |
111 |
| -These instructions will continue in Codespaces in the `readme.md` (double-click it if it does not open automatically). |
112 |
| - |
113 |
| - |
114 |
| - |
115 |
| -## 4. Explore the Readme |
116 |
| - |
117 |
| -Open the `readme` to explore the sample project. |
118 |
| - |
119 |
| -<details markdown> |
120 |
| - |
121 |
| -<summary>Tutorial Overview</summary> |
122 |
| - |
123 |
| -The Tutorial will enable you to explore 2 key aspects: |
124 |
| - |
125 |
| -* __Initial Automation__ - API and UI creation are automated from the data model. So, later, you'd see this level of automation for your own databases. |
126 |
| - |
127 |
| -* __Customization and Debugging__ - this sample also includes customizations for extending the API and declaring logic, and how to use VSCode to debug these. The Tutorial will clearly identify such pre-built customizations. |
128 |
| - |
129 |
| -</details> |
130 |
| - |
131 |
| - |
132 |
| - |
133 |
| -Extensive [product documentation is available here](https://valhuber.github.io/ApiLogicServer/) - checkout the [FAQs](https://valhuber.github.io/ApiLogicServer/FAQ-Frameworks/). |
134 |
| - |
135 |
| - |
136 |
| - |
137 |
| -# API Logic Server Background |
138 |
| - |
139 |
| -### Motivation |
140 |
| - |
141 |
| -We looked at approaches for building database systems: |
142 |
| - |
143 |
| -<br/> |
144 |
| - |
145 |
| -__Frameworks__ |
146 |
| - |
147 |
| -Frameworks like Flask or Django enable you to build a single endpoint or _Hello World_ page, but a __multi-endpoint__ API and __multi-page__ application would take __weeks__ or more. |
148 |
| - |
149 |
| -<br/> |
150 |
| - |
151 |
| -__Low Code Tools__ |
152 |
| - |
153 |
| -These are great for building great UIs, but |
154 |
| - |
155 |
| -* Want a multi-page app -- __without requiring detail layout for each screen__ |
156 |
| -* Want to __preserve standard dev tools__ - VSCode, PyCharm, git, etc |
157 |
| -* Need an answer for __backend logic__ (it's nearly half the effort) |
158 |
| - |
159 |
| - |
160 |
| - |
161 |
| -### Our Approach: Instant, Standards-based Customization, Logic Automation |
162 |
| - |
163 |
| -API Logic Server is an open source Python project. It runs as a standard Python (`pip`) install, or under Docker. It consists of: |
164 |
| - |
165 |
| -* a set of runtimes (api, user interface, data access) for project execution, plus |
166 |
| - |
167 |
| -* a CLI (Command Language Interface) to create executable projects with a single command |
168 |
| - |
169 |
| -Then, |
170 |
| - |
171 |
| -* Customize your projects in standard IDEs such as VSCode or PyCharm |
172 |
| - |
173 |
| -* Declare multi-table derivations and constraint logic using spreadsheet-like rules |
174 |
| - |
175 |
| - * :trophy: 40X more concise than code |
176 |
| - * Extend with Python |
177 |
| - |
178 |
| - |
179 |
| -> :bulb: API Logic Server reads your schema, and creates an executable, customizable project. |
180 |
| -
|
181 |
| - |
| 1 | +!!! pied-piper ":bulb: TL;DR - Using Logic: Understand functions vs. lambda, logic_row" |
182 | 2 |
|
| 3 | + The fastest way to explore API Logic Server - *with __no install__* - is to run the demo at the [Home Page](https://www.genai-logic.com){:target="_blank" rel="noopener"}, and then proceed to open the project in GitHub with Codespaces. |
| 4 | + |
| 5 | + This is explained in the readme of the generated app. |
0 commit comments