跳到主要内容

快速开始

提示

本文默认你已经了解并熟悉NodeJS编程，

如果你对NodeJS的部署和配置不熟悉，

同时也对JavaScript主流的打包工具不熟悉，

请前往https://lvyjs.dev了解

初始化​

文档统一采用yarn依赖工具
npm install yarn -g 
npm init -y
yarn add alemonjs  @alemonjs/gui

运行示例​

index.js
import { start } from 'alemonjs'
start()
lib/index.js
export default defineChildren({
  onCreated() {
    logger.info({
      message: '启动应用'
    })
  }
})
package.json
{
  // 确保文件拥有以下内容
  "main": "lib/index.js", // 入口文件
  "type": "module",
  "scripts": {
    "app": "node index.js" // 启动脚本
  }
}
  • 启动
yarn app

测试平台​

下载编辑器 Visual Studio Code

下载编辑器扩展 ALemonJS GUI

yarn app --login gui

配置文件​

alemon.config.yaml
port: 17117 # 端口，快捷参数 --port
input: 'lib/index.js' # 入口地址，快捷参数 --input
# login: 'gui' # 选择登录的平台，快捷参数 --login
# 可连接 另一个 alemonjs 服务，并全量接收消息
# url: 'ws://127.0.0.1:17117' # 连接URL，快捷参数 --url
# 不全量接收消息（用于分流处理，需确保连接端拥有相同的处理能力）
# is_full_receive: false
# 加载模块, 具体见文档后续内容
# apps:
#  - 'alemonjs-openai'
# 模块配置, 约定。模块对应的配置名，应是模块名。
# alemonjs-openai
#   baseURL: 'https://api.deepseek.com'
#   apiKey: ''
#   model: 'deepseek-chat'
  • 框架服务端口约定 [17100-17199]

17117: 框架默认端口

17127: GUI默认端口

  • 框架应用端口约定 [18100-18999]

环境变量​

namespace NodeJS {
  interface ProcessEnv {
    login?: string
    platform?: string
    port?: string
    // development 模式下。可查看 logger.debug 记录
    NODE_ENV?: 'development' | 'production'
  }
}

对TS的支持​

推荐 使用lvyjs开发构建工具，以支持ts环境

请前往https://lvyjs.dev了解