# stellia 项目初始化和修改规范 ## 项目初始化规范 ### 项目命名规范 1. web命名 & context命名 : `stellia-{项目名}` 2. 后端api命名 & context命名 : `stellia-{项目名}-api` 相同的前后端 3. 静态资源命名 : `stellia-{项目名}-static` 相同的前后端 4. 全局context 命名规范:所有静态资源需以可配置环境变量HOST+context为前缀进行资源访问 5. 非前后端项目,纯工具/脚本/工作任务类项目,则直接按功能命名 如pdf-converter site-capture 前后端项目说明: - 项目通常以前端为主应用,默认1个前端对应一个同名后端api,对应后端接口支持配置不同后端服务context,根据context区分。 - 前端一般默认一个静态资源,同样支持配置多个静态资源context前缀, - 所有静态资源访问路径需使用可配置的HOST+context变量作为相对路径,避免硬编码,如: - bookshelf项目目前主要 使用stellia-bookshelf-static,对应全局变量配置`static_main=stellia-bookshelf-static`, - 后续可能有其它静态资源 可以配置 `static_practise=stellia-practise-static`,命名规则为static_{name}=stellia-{name}-static - 在代码中引用静态资源时,通过{ENV_HOST:xxx}+{context:static_main}+{resource_uri:xxx/xxx.mp3} 方式引用资源路径: - http://localhost/stellia-bookshelf-static/audio/xxx.mp3 - http://prod-host/stellia-bookshelf-static/audio/xxx.mp3 - http://prod-host/stellia-practise-static/avatar/user-img.png ### 端口规范 根据 [AGENTS.md](..%2F..%2F..%2FAGENTS.md)中已有端口依次向后累加进行项目初始化,除非用户有特殊要求 - 前端从5100 每次加10 即 5100 5110 5120 ... - 后端从8100 每次加10 即 8100 8120 8130 ... - 项目初始化后 更新 [AGENTS.md](..%2F..%2F..%2FAGENTS.md)