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

Update adr-001-jan-deployable-cloud-native.md

Browse Source
This commit is contained in:
nam-john-ho 2023-10-09 22:48:54 +07:00 committed by GitHub
parent 33abc71974
commit f596131887
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
adr/adr-001-jan-deployable-cloud-native.md
View File

@ -26,15 +26,21 @@
### Key Design Decisions
![Key Design](images/adr-001-01.png "Key Design")
Introduce 2 components in Jan:
- Middleware: responsible for routing the user interface to the appropriate platform (Electron/WebApp) that is built when packaged.
- Http server: a http server on cloud environment which interacts with plugin directly.
![Key Design](images/adr-001-02.png "Key Design")
#### Why middleware
* The /web codebase needs to operate in both browser and electron environments
* The /web codebase needs to route plugin routes accordingly, either to /server or /electron
* Middleware takes care of this
* We will have a /server codebase that takes care of routing to plugins
#### Unsuitable Alternatives
* Not possible to just run electron headless
* /web is on a different chromium window
* Does not have all the electron handlers
* Does not have the IPC handler
### Detailed Design
#### FE
- Middleware:
![Middleware](images/adr-001-01.png "Middleware")
- Httpserver: TBD
- Custom build for httpweb/electron: TBD
- IPC