Skip to content

Commit d32651f

Browse files
committed
Landing Page uncluttered, Pick up / Leave off
1 parent 120ab26 commit d32651f

File tree

3 files changed

+87
-5
lines changed

3 files changed

+87
-5
lines changed

docs/Doc-Home.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
!!! pied-piper ":bulb: TL;DR - Open Source, CLI, Standard IDE, Standard Runtime"
2+
3+
Weclcome to API Logic Server. It's an open source project designed to create microservices quickly and easily.
4+
5+
This page provides a project summary. For more detailed information, select a page from the list at left.
6+
7+
**Creation**
8+
9+
* Create projects using the CLI, from a database, a SQLAlchemy model, or an AI description.
10+
11+
**Development**
12+
13+
* **Standards-based customization** - debug in a standard IDE (VSCode, PyCharm), using standard packages (Flask, SQLAlchemy)
14+
15+
**Deployment**
16+
17+
* A modern 3-tiered architecture, accessed by **APIs**
18+
* Logic is **automatically reused**, factored out of web apps and custom services
19+
* **Containerized** for scalable cloud deployment - the project includes a dockerfile to containerize it to DockerHub.
20+
21+
22+
## Runtimes and CLI
23+
24+
API Logic Server is a Python Application, consisting of:
25+
26+
1. __Runtimes__ for ApiLogicProject execution (see below)
27+
2. __CLI__ (Command Language Interface - provides `ApiLogicServer create `…`)
28+
29+
It executes either as a locally install (venv), or a Docker image (which includes Python). In either case, the contents are the same:
30+
31+
![API Logic Server Intro](images/Architecture-What-Is.png)
32+
33+
 
34+
35+
## Created Projects
36+
37+
Created projects are designed for Customization.
38+
39+
![Flexibility of a Framework](images/sample-ai/copilot/customize.png)
40+
41+
## Key Runtime Components
42+
43+
![API Logic Server Runtime Stack](images/Architecture-Runtime-Stack.png)
44+
45+
The following
46+
47+
| Component | Provides |
48+
|:---------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
49+
| [Flask](https://flask.palletsprojects.com/en/1.1.x){:target="_blank" rel="noopener"} | enables you to write custom web apps, and custom api end points |
50+
| [SQLAlchemy](https://docs.sqlalchemy.org/en/14/core/engines.html){:target="_blank" rel="noopener"} | Python-friendly ORM (analogous to Hiberate, JPA) |
51+
| [Logic Bank](Logic-Operation.md#logic-architecture){:target="_blank" rel="noopener"} | Listens for SQLAlchemy updates, provides Multi-Table Derivations and Constraint Rules<br>Python Events (e.g., send mail, message)<br>Customizable with Python<br> |
52+
| [SAFRS](https://github.com/thomaxxl/safrs/wiki){:target="_blank" rel="noopener"} | JSON:API and swagger, based on SQLAlchemy |
53+
| [SAFRS-RA](https://github.com/thomaxxl/safrs-react-admin){:target="_blank" rel="noopener"} | *Admin App*, using SAFRS |
54+
55+
56+
&nbsp;
57+
58+
## Execution: 3-tiered architecture
59+
60+
The API Logic Server executes as an application server, accessed by an API, in a standard 3-tiered architecture.
61+
62+
Observe that logic plugs into SQLAlchemy. **Logic is thus automatically shared** (factored out) of custom services, and web or browser-based apps.
63+
64+
In most cases, the API Logic Server executes in a **container**, so scales horizontally like any other Flask-based server.
65+
66+
![API Logic Server Intro](images/Architecture.png)

docs/images/hero-banner.png

-13.5 KB
Loading

docs/index.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: API Logic Server
3+
hide:
4+
- navigation
35
Description: Instantly Create and Run Database Projects - GenAI, Flask, APIs, SQLAlchemy, React Apps, Rules, Low-Code
46
---
57
<style>
@@ -12,12 +14,12 @@ Description: Instantly Create and Run Database Projects - GenAI, Flask, APIs, SQ
1214
[![Latest Version](https://img.shields.io/pypi/v/apilogicserver.svg)](https://pypi.python.org/pypi/apilogicserver/)
1315
[![Supported Python versions](https://img.shields.io/pypi/pyversions/apilogicserver.svg)](https://pypi.python.org/pypi/apilogicserver/)
1416

15-
[![API Logic Server Intro](images/hero-banner.png)](#instant-evaluation-no-install "Click for instant cloud-based, no-install eval")
1617

17-
# API Logic Server - In Action
18+
[![API Logic Server Intro](images/hero-banner.png)](Doc-Home.md "Click for Docs")
1819

19-
API Logic Server is the simplest, fastest, and most flexible way to create and customize microservices. Create from a Natural Language prompt or existing database, literally in seconds, for an Admin App and JSON:API. Unique Logic Automation. Standards-based customization and deployment provide full flexibility.
20+
# API Logic Server - In Action
2021

22+
Create microservices instantly, as shown below. [Click here](Doc-Home.md) for documentation.
2123
&nbsp;
2224

2325
## 1. Simplicity of AI
@@ -70,12 +72,16 @@ als genai --using=genai_demo.prompt
7072

7173
&nbsp;
7274

73-
### --> Instant Microservice
75+
<details markdown>
76+
77+
<summary>App and API are ready to run</summary>
7478

7579
The system creates the database, and an executable project providing API and App Automation. The microservice is ready to run, instantly:
7680

7781
![Created Microservice](images/sample-ai/copilot/created-microservice.png)
7882

83+
</details>
84+
7985
&nbsp;
8086

8187
## 3. Flexibility of a Framework
@@ -86,6 +92,16 @@ You can then **customize the project with Python in your IDE.** Create executab
8692

8793
&nbsp;
8894

95+
# Pick Up Where Others Leave Off
96+
97+
API Logic Server **differentiates** from traditional approaches:
98+
99+
* Unlike basic GenAI, API Logic Server creates systems from prompts **at the business level**, instead of low-level framework details.
100+
101+
* Unlike frameworks, API Logic Servers preserves full flexibility and standard Dev Tools, with **automation** to eliminate weeks-to-months of complex development.
102+
103+
* Unlike Low Code, API Logic Server provides **logic automation,** and preserves the **framework flexibility.**
104+
89105
# Video - 1 minute
90106

91107
[![GenAI Automation](images/sample-ai/copilot/genai-automation-video-60.png)](https://www.youtube.com/watch?v=6wnPsI5S6NM "Microservice Automation"){:target="_blank" rel="noopener"}
@@ -751,7 +767,7 @@ We'd love to hear from you:
751767

752768
1. Email: apilogicserver@gmail.com
753769
2. Issues: [github](https://github.com/ApiLogicServer/ApiLogicServer-src/issues){:target="_blank" rel="noopener"}
754-
3. Slack: [https://apilogicserver.slack.com](https://join.slack.com/t/apilogicserver/signup?x=x-p3388652117142-3395302306098-5241761647201)
770+
3. Slack: contact us on apilogicserver.slack.com
755771

756772
---
757773

0 commit comments

Comments
 (0)