rubick/assets/js/11.861f0d8b.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{283:function(s,a,t){"use strict";t.r(a);var e=t(14),n=Object(e.a)({},(function(){var s=this,a=s._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h2",{attrs:{id:"赞助"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#赞助"}},[s._v("#")]),s._v(" 赞助")]),s._v(" "),a("p",[a("code",[s._v("rubick")]),s._v(" 是非盈利项目，开源不容易，如果该项目对你有用的话，可以打赏我们喝杯 coffee ☕️.")]),s._v(" "),a("img",{attrs:{width:"200",src:"https://pic1.zhimg.com/80/v2-688385687a37e962fe32daf136139feb_720w.png"}}),s._v(" "),a("img",{attrs:{width:"200",src:"https://pica.zhimg.com/80/v2-1ba296fd2cece45ee1094ee7c259035c_720w.png"}}),s._v(" "),a("h2",{attrs:{id:"贡献代码"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#贡献代码"}},[s._v("#")]),s._v(" 贡献代码")]),s._v(" "),a("h3",{attrs:{id:"rubick-目录介绍"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rubick-目录介绍"}},[s._v("#")]),s._v(" rubick 目录介绍")]),s._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v(".")]),s._v("\n├── docs "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 文档存方目录")]),s._v("\n│   ├── docs\n│   ├── package-lock.json\n│   ├── package.json\n│   └── pnpm-lock.yaml\n├── feature "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 插件市场插件")]),s._v("\n│   ├── README.md\n│   ├── babel.config.js\n│   ├── package-lock.json\n│   ├── package.json\n│   ├── public\n│   ├── src\n│   ├── tsconfig.json\n│   └── vue.config.js\n├── public "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# rubick __static 目录")]),s._v("\n│   ├── favicon.ico\n│   ├── feature\n│   ├── icons\n│   ├── index.html\n│   ├── preload.js\n│   └── tpl\n├── src "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# rubick 核心源码")]),s._v("\n│   ├── common "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 一些通用的函数")]),s._v("\n│   ├── core "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 一些核心的能力，比如 app search")]),s._v("\n│   ├── main "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 主进程")]),s._v("\n│   └── renderer "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 渲染进程")]),s._v("\n├── tpl "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# rubick 模板插件")]),s._v("\n│   ├── README.md\n│   ├── babel.config.js\n│   ├── package-lock.json\n│   ├── package.json\n│   ├── public\n│   ├── src\n│   ├── tsconfig.json\n│   └── vue.config.js\n├── LICENSE "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# MIT 协议")]),s._v("\n├── README.md "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 英文文档")]),s._v("\n├── README.zh-CN.md "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# 中文文档")]),s._v("\n├── babel.config.js\n├── deploy-doc.sh "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# rubick doc 发布脚本")]),s._v("\n├── tsconfig.json\n├── package-lock.json\n├── package.json\n└── vue.config.js\n")])])]),a("h3",{attrs:{id:"启动"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#启动"}},[s._v("#")]),s._v(" 启动")]),s._v(" "),a("h4",{attrs:{id:"_1-安装依赖"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#_1-安装依赖"}},[s._v("#")]),s._v(" 1. 安装依赖")]),s._v(" "),a("p",[a("code",[s._v("rubick")]),s._v(" 启动主要涉及到3个目录：")]),s._v(" "),a("ol",[a("li",[s._v("根目录："),a("code",[s._v("rubick")]),s._v(" 核心进程")]),s._v(" "),a("li",[s._v("feature："),a("code",[s._v("rubick")]),s._v(" 内置的插件市场插件")]),s._v(" "),a("li",[s._v("tpl: "),a("code",[s._v("rubick")]),s._v(" 内置的模板插件")])]),s._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[s._v("$ "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" i\n$ "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" feature "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("&&")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" i\n$ "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" tpl "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("&&")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" i\n")])])]),a("h4",{attrs:{id:"_2-启动核心进程"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#_2-启动核心进程"}},[s._v("#")]),s._v(" 2. 启动核心进程")]),s._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[s._v("$ "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" run electron:serve\n")])])]),a("h4",{attrs:{id:"_3-启动插件中心"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#_3-启动插件中心"}},[s._v("#")]),s._v(" 3. 启动插件中心 "),a("Badge",{attrs:{type:"warning",text:"非必须",vertical:"top"}})],1),s._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[s._v("$ "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" feature "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("&&")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" run serve\n")])])]),a("h4",{attrs:{id:"_4-启动模板插件"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#_4-启动模板插件"}},[s._v("#")]),s._v(" 4. 启动模板插件 "),a("Badge",{attrs:{type:"warning",text:"非必须",vertical:"top"}})],1),s._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[s._v("$ "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" tpl "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("&&")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" run serve\n")])])]),a("h3",{attrs:{id:"编译"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#编译"}},[s._v("#")]),s._v(" 编译")]),s._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[s._v("$ "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" feature "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("&&")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" run build\n$ "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" tpl "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("&&")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" run build\n$ "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" run electron:build\n")])])]),a("h3",{attrs:{id:"pr"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#pr"}},[s._v("#")]),s._v(" PR")]),s._v(" "),a("ol",[a("li",[s._v("Create an issue about the features, such as new components.")]),s._v(" "),a("li",[s._v("Fork the repo to your own account.")]),s._v(" "),a("li",[s._v("Clone your fork.")]),s._v(" "),a("li",[s._v("Create a new branch base on dev, if you want to add new component, the branch name should be formatted as component-[Component Name]. (e.g. component-steps) And the commit info should be formatted as [Component Name]: Info about commit.")]),s._v(" "),a("li",[s._v("Make sure that running npm run prepublish outputs the correct files.")]),s._v(" "),a("li",[s._v("Rebase before creating a PR to keep commit history clear. (Merge request to branch dev)")]),s._v(" "),a("li",[s._v("Provide some description about your PR.")])])])}),[],!1,null,null,null);a.default=n.exports}}]);