Skip to content

Commit

Permalink
Edit
Browse files Browse the repository at this point in the history
  • Loading branch information
tyt2y3 committed Jan 12, 2025
1 parent 9d81cbb commit 643beb4
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 10 deletions.
12 changes: 5 additions & 7 deletions sea-orm-pro/docs/01-index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# Index

## Introduction

1. Introduction

1.1 [What is SeaORM Pro](01-introduction/01-sea-orm-pro.md)

1.2 [SeaORM Pro Plus](01-introduction/02-sea-orm-pro-plus.md)

## Basics

2. Installation & Configuration

2.1 [Getting Started with Loco](02-install-and-config/01-getting-started-loco.md)
Expand All @@ -18,11 +14,13 @@

3. Site Config

3.1 [Theme](03-site-config/01-theme.md)
3.1 [Overview](03-site-config/01-overview.md)

3.2 [Theme](03-site-config/02-theme.md)

4. Raw Table Config

4.1 [The Basics](04-raw-table-config/01-basics.md)
4.1 [Overview](04-raw-table-config/01-overview.md)

4.2 [Table](04-raw-table-config/02-table.md)

Expand All @@ -36,7 +34,7 @@

5. Composite Table Config

5.1 [The Basics](05-composite-table-config/01-basics.md)
5.1 [Overview](05-composite-table-config/01-overview.md)

5.2 [Parent Table](05-composite-table-config/02-parent-table.md)

Expand Down
19 changes: 18 additions & 1 deletion sea-orm-pro/docs/01-introduction/01-sea-orm-pro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# What is SeaORM Pro

SeaORM Pro is an admin panel solution ...
SeaORM Pro is an admin panel solution allowing you to quickly and easily launch an admin panel for your application - frontend development skills not required (but certainly nice to have).

An admin panel is essential for operating backend applications. But it often is an after-thought, or no dedicated resources (aka developer time) is put into developing them.

Frontend engineers are usually focused on developing consumer-facing applications, which often led to insufficient effort being directed towards GUI of internal-facing applications.

SeaORM Pro is designed to bridge this gap, providing a solution that is both quick to implement and reliable for long-term use.

There are several engineering problems we are trying to solve:

1. The tediousness of manually writing query handlers to select, sort, filter and paginate data. While this can be abstracted away for individual tables, custom code is often needed for queries involving joins.
+ Solution: Seaography removes the need to writing GraphQL resolvers manually, all you need to provide is a set of SeaORM entities (which can be generated with `sea-orm-cli`)!
2. The difficulty in customizing frontend by writing frontend code. Certainly a barrier for us backend engineers to mess with React SPA code!
+ Solution: SeaORM Pro allows customizing the frontend by writing TOML config, a language Rust developers already know (because of Cargo).
3. The difficulty in keeping the admin panel in sync with the application's schema after adding new tables and columns.
+ Solution: develop your application using SeaORM. You can share the same set of entities between your app and the admin panel, so any schema changes are automatically reflected in the GraphQL schema and the admin panel. You only have to touch the config to customize things
4. The long term viability in managing growth in complexity. Low-code solutions will eventually hit a functionality ceiling, requiring a rewrite to implement certain features.
+ Solution: builting using commodity technologies, SeaORM Pro offer a pathway to develop a fully-fledged admin application

## Architecture

Expand Down
13 changes: 13 additions & 0 deletions sea-orm-pro/docs/03-site-config/01-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Overview

## File Folder

All TOML config should be placed under the `pro_admin` folder by convention.

The config files are parsed on runtime and merged into one big config object, which is then served to the frontend on application start.

So these config files should be part of the application deployment, just like other static assets.

In development, we recommend reloading the config on every client request. This allows you to change the config of the admin panel on-the-fly! Simply hit "Refresh" in the browser.

In production, we recommend loading this config once-only on startup. So if you'd like to apply config changes, you don't have to rebuild the application, you can simply update the config and restart the application.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The Basics
# Overview

## File Folder

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The Basics
# Overview

## File Folder

Expand Down

0 comments on commit 643beb4

Please sign in to comment.