Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Initial commit for architecture overview

Browse Source
This commit is contained in:
Service Account 2023-10-26 09:49:07 +07:00
parent 867e79a37e
commit 78a495b8c2
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/docs/overview/architecture.md
View File

@ -3,4 +3,20 @@ sidebar_position: 1
title: Architecture title: Architecture
--- ---
TODO ## Jan overall architecture
![Overall architecture](img/architecture-1.drawio.png)
- Jan platform includes the following components:
- Processes:
- UI process:
- This is Electron framework `renderer` component (Web technology equivalent)
- Jan provides core platform UI that:
- Allows App to `register()` function blueprint with name and arguments
- Run `execute()` registered App functions
- Node process (NodeJS technology equivalent)
- This is Electron framework `main process` component (NodeJS runtime)
- Jan provides core platform UI that:
- Allows App to `register()` function blueprint with name and arguments
- Run `execute()` registered App functions
- `@janhq/core` library that exposes Core API for App to reuse. Currently it only supports App `index.ts`
- Vertically, there are `Platform Core` component and `App` component. Each of those includes UI and Node process that work in pair.