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

fix: nits

Browse Source
This commit is contained in:
0xSage 2023-10-27 16:11:10 +07:00
parent 965755871e
commit 876915ed8c
6 changed files with 126 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/getting-started/app-anatomy.md
View File

@ -4,8 +4,10 @@ title: Anatomy of an app
---
### High level architecture
![High level architecture](img/architecture-0.drawio.png)
Jan mission is to power the next gen App with the limitless extensibility by providing BUILDER:
- Unified API/ Helpers so that they only need to care about what matters
- Wide range of Optimized and State of the art models that can help your App with Thinking/ Hearing/ Seeing capabilities. This is powered by our [Nitro](https://github.com/janhq/nitro)
- Strong support for App marketplace and Model market place that streamline value from end customers to builders at all layers
@ -14,7 +16,9 @@ Jan mission is to power the next gen App with the limitless extensibility by pro
At Jan, we strongly believe in `portable AI` that is created once and run anywhere.
### Low level architecture
![Low level architecture](img/architecture-1.drawio.png)
- Jan platform includes the following components:
- Processes:
@ -33,18 +37,26 @@ At Jan, we strongly believe in `portable AI` that is created once and run anywhe
- Vertically, there are `Platform Core` component and `App` component. Each of those includes UI and Node process that work in pair.
## Events
![Platform events](img/app-anatomy-4.drawio.jpg)
#### onLaunch()
![Platform onLaunch()](img/app-anatomy-1.drawio.jpg)
![Platform onLaunch()](img/app-anatomy-1.drawio.jpg)
#### onStart()
![Platform onStart()](img/app-anatomy-2.drawio.jpg)
![Platform onStart()](img/app-anatomy-2.drawio.jpg)
#### onDispose()
![Platform onDispose()](img/app-anatomy-3.drawio.jpg)
![Platform onDispose()](img/app-anatomy-3.drawio.jpg)
#### onAppInstallation() and onAppUninstallation()
The Platform simply restarts and trigger onDispose() then onLaunch().
### Information flow
- When App is being used, here is how the information passes between Platform and Apps
![Communication](img/app-anatomy-5.drawio.png)

103
docs/docs/getting-started/build-an-app.md
View File

@ -4,37 +4,44 @@ title: Build an app
---
# Build and publish an app
Apps let you extend Obsidian with your own features to create a custom note-taking experience.
In this tutorial, you'll compile a sample plugin from source code and load it into Obsidian.
You can build a custom AI application on top of Jan.
In this tutorial, you'll build a sample app and load it into Jan Desktop.
## What you'll learn
After you've completed this tutorial, you'll be able to:
- Configure an environment for developing Jan apps.
- Compile a app from source code.
- Reload a app after making changes to it.
## Prerequisites
To complete this tutorial, you'll need:
- [Git](https://git-scm.com/) installed on your local machine.
- A local development environment for [Node.js](https://node.js.org/en/about/).
- A code editor, such as [Visual Studio Code](https://code.visualstudio.com/).
## Before you start
When developing apps, one mistake can lead to unintended changes to your app. Please backup the data.
## Before you start
When developing apps, one mistake can lead to unintended changes to your app. Please backup your data.
## Development
### Step 1: Download the sample plugin
### Step 1: Download the sample app
- Go to [Jan sample app](https://github.com/janhq/jan-sample-app)
- Select `Use this template button` at the top of the repository
- Select `Create a new repository`
- Select an owner and name for your new repository
- Click `Create repository`
- Clone your new repository
- Start developing locally
- Git clone your new repository
### Step 2: Initial Setup
After you've cloned the repository to your local machine or codespace, you'll need to perform some initial setup steps before you can develop your plugin.
Next, you'll need to perform some initial setup steps.
> [!NOTE]
>
@ -59,55 +66,40 @@ After you've cloned the repository to your local machine or codespace, you'll ne
1. :white_check_mark: Check your artifact
There will be a tgz file in your plugin directory now
There will be a tgz file in your src directory now
### Step 3: Update the Plugin Metadata
### Step 3: Update the App Manifest
The [`package.json`](package.json) file defines metadata about your plugin, such as
plugin name, main entry, description and version.
When you copy this repository, update `package.json` with the name, description for your plugin.
The [`package.json`](package.json) file lets you define your apps metadata, e.g.
app name, main entry, description and version.
### Step 4: Update the Plugin Code
The [`src/`](./src/) directory is the heart of your plugin! This contains the source code that will be run when your plugin extension functions are invoked. You can replace the contents of this directory with your own code.
The [`src/`](./src/) directory is the heart of your app!
There are a few things to keep in mind when writing your plugin code:
- `index.ts` is your UI to end customer with Web runtime. This one should be thin as lightweight. Any specific/ compute-intensive workload should be executed asynchronously in registered functions in `module.ts`.
- `module.ts` is your Node runtime in which functions get executed.
- `index.ts` and `module.ts` interact with each other via RPC (See [Information flow](./app-anatomy.md#information-flow))
- Most Jan Plugin Extension functions are processed asynchronously.
In `index.ts`, you will see that the extension function will return a `Promise<any>`.
You can replace the contents of this directory with your own code.
```typescript
import { core } from "@janhq/core";
#### index.ts
function onStart(): Promise<any> {
return core.invokePluginFunc(MODULE_PATH, "run", 0);
}
```
Think of this as your "app frontend". You register events, custom functions here.
For more information about the Jan Plugin Core module, see the
[documentation](https://github.com/janhq/jan/blob/main/core/README.md).
Most Jan App functions are processed asynchronously.
In `index.ts`, you will see that the extension function will return a `Promise<any>`.
- You may be confused of `index.ts` and `module.ts`.
- `index.ts` is your UI to end customer with Web runtime. This one should be thin as lightweight. Any specific/ compute-intensive workload should be executed asynchronously in registered functions in `module.ts`.
- `module.ts` is your Node runtime in which functions get executed.
- `index.ts` and `module.ts` interact with each other via RPC (See [Information flow](./app-anatomy.md#information-flow))
```typescript
import { core } from "@janhq/core";
- Define specific/ compute intensive function in `module.ts`
```javascript
const path = require("path");
const { app } = require("electron");
function run(param: number): [] {
console.log(`execute runner ${param} in main process`);
return [];
function onStart(): Promise<any> {
return core.invokePluginFunc(MODULE_PATH, "run", 0);
}
module.exports = {
run,
};
```
- Define functions to register and use the registered function in `index.ts`
```javascript
/**
* The entrypoint for the plugin.
@ -133,15 +125,40 @@ export function init({ register }: { register: RegisterExtensionPoint }) {
}
```
For more information about the Core module, see the
[documentation](https://github.com/janhq/jan/blob/main/core/README.md).
#### module.ts
Think of this as your "app backend". Your core logic implementation goes here.
```javascript
const path = require("path");
const { app } = require("electron");
function run(param: number): [] {
console.log(`execute runner ${param} in main process`);
return [];
}
module.exports = {
run,
};
```
So, what are you waiting for? Go ahead and start customizing your plugin!
## App installation
![Manual installation](img/build-app-1.png)
- `Select` the built `*.tar.gz` file
- The App will reload after new app get installed
## App uninstallation
To be updated
## App update
To be updated
To be updated

46
docs/docs/getting-started/cloud-native.md Normal file
View File

@ -0,0 +1,46 @@
---
sidebar_position: 5
title: Cloud Native
---
This is an experimental feature - expect breaking changes!
## Use Case
- User doesn't have a local GPU machine but wants to run Jan on a rented server
- User wants a quick, fast way to experiment with Jan on a rented GPU
### Getting Started
#### Run from source code
```bash
git clone https://github.com/janhq/jan
cd jan
git checkout feat-255 && git pull
yarn install
yarn start:server
```
Open your browser at [http://localhost:4000](http://localhost:4000)
### Run from docker file
```bash
git clone https://github.com/janhq/jan
cd jan
git checkout feat-255 && git pull
docker build --platform linux/x86_64 --progress=plain -t jan-server .
docker run --platform linux/x86_64 --name jan-server -p4000:4000 -p3928:3928 -it jan-server
```
Open your browser at [http://localhost:4000](http://localhost:4000)
### Architecture
![cloudnative](img/cloudnative.png)
### To-dos
- [Authencation Plugins](https://github.com/janhq/jan/issues/334)
- [Remote server](https://github.com/janhq/jan/issues/200)

BIN
docs/docs/getting-started/img/cloudnative.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 158 KiB

3
docs/docs/getting-started/nitro.md
View File

@ -1,4 +1,5 @@
---
sidebar_position: 4
title: Nitro (C++ Inference Engine)
---
@ -69,5 +70,7 @@ curl -X POST 'http://localhost:3928/inferences/llamacpp/loadmodel' \
"embedding": true
}'
```
## Architecture diagram
![Nitro Architecture](img/architecture.png)

2
docs/docs/getting-started/publish-jan-app.md
View File

@ -4,7 +4,9 @@ title: Publishing a Jan app
---
# Publish Jan app
After you have completed with local app development and want to publish to `Jan marketplace` for other to reuse, please follow the following steps
- Step 1: Update your local `package.json` and configure `npm login` correctly
- Step 2: Run `npm publish` and set to public NPM package (so that other can install) - Please refer to our example [NPM retrieval plugin](https://www.npmjs.com/package/retrieval-plugin)
- Step 3: Go to `Jan plugin catalog`(https://github.com/janhq/plugin-catalog) and create a `Pull request` for new `App artifact` (which is a renamed version of your App `package.json`) - Please refer to example [retrieval-plugin](https://github.com/janhq/plugin-catalog/blob/main/retrieval-plugin.json)