-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathquickstart.html
32 lines (30 loc) · 9.06 KB
/
quickstart.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>关于 akajs | Kalengo akajs</title>
<meta name="description" content="Just playing around">
<link rel="preload" href="/akajs_doc/assets/css/0.styles.ef030843.css" as="style"><link rel="preload" href="/akajs_doc/assets/js/app.0fa76309.js" as="script"><link rel="preload" href="/akajs_doc/assets/js/2.4bdd5d90.js" as="script"><link rel="preload" href="/akajs_doc/assets/js/8.b8622590.js" as="script"><link rel="prefetch" href="/akajs_doc/assets/js/3.c5c230c2.js"><link rel="prefetch" href="/akajs_doc/assets/js/4.59116900.js"><link rel="prefetch" href="/akajs_doc/assets/js/5.d9d48266.js"><link rel="prefetch" href="/akajs_doc/assets/js/6.b82dadbb.js"><link rel="prefetch" href="/akajs_doc/assets/js/7.1bc09903.js"><link rel="prefetch" href="/akajs_doc/assets/js/9.6613c730.js">
<link rel="stylesheet" href="/akajs_doc/assets/css/0.styles.ef030843.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/akajs_doc/" class="home-link router-link-active"><!----> <span class="site-name">Kalengo akajs</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/akajs_doc/" class="nav-link">首页</a></div><div class="nav-item"><a href="/akajs_doc/guide.html" class="nav-link">指南</a></div><div class="nav-item"><a href="https://github.com/kaolalicai/akajs" target="_blank" rel="noopener noreferrer" class="nav-link external">
Github
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/akajs_doc/" class="nav-link">首页</a></div><div class="nav-item"><a href="/akajs_doc/guide.html" class="nav-link">指南</a></div><div class="nav-item"><a href="https://github.com/kaolalicai/akajs" target="_blank" rel="noopener noreferrer" class="nav-link external">
Github
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/akajs_doc/" class="sidebar-link">Home</a></li><li><a href="/akajs_doc/quickstart.html" class="active sidebar-link">快速开始</a></li><li><a href="/akajs_doc/guide.html" class="sidebar-link">指南</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#目标" class="sidebar-link">目标</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#akajs-的主要模块" class="sidebar-link">akajs 的主要模块</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#常用的-koa-中间件" class="sidebar-link">常用的 Koa 中间件</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#系统配置-config" class="sidebar-link">系统配置 config</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#模块化" class="sidebar-link">模块化</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#注解式路由" class="sidebar-link">注解式路由</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#ioc-依赖注入" class="sidebar-link">IOC 依赖注入</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#参数和返回值处理" class="sidebar-link">参数和返回值处理</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#mongoose-支持" class="sidebar-link">Mongoose 支持</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#mongoose-事务" class="sidebar-link">Mongoose 事务</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#crud" class="sidebar-link">CRUD</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#自动加载机制" class="sidebar-link">自动加载机制</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#logger" class="sidebar-link">Logger</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#健康检查" class="sidebar-link">健康检查</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#常用工具" class="sidebar-link">常用工具</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#api-接口文档" class="sidebar-link">API 接口文档</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#test" class="sidebar-link">Test</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/guide.html#todo" class="sidebar-link">TODO</a></li></ul></li><li><a href="/akajs_doc/changelog.html" class="sidebar-link">Changelog</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-6-0" class="sidebar-link">0.6.0</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-5-5" class="sidebar-link">0.5.5</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-5-0" class="sidebar-link">0.5.0</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-4-5" class="sidebar-link">0.4.5</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-4-0" class="sidebar-link">0.4.0</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-3-0" class="sidebar-link">0.3.0</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-2-0" class="sidebar-link">0.2.0</a></li><li class="sidebar-sub-header"><a href="/akajs_doc/changelog.html#_0-1-0" class="sidebar-link">0.1.0</a></li></ul></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="关于-akajs"><a href="#关于-akajs" class="header-anchor">#</a> 关于 akajs</h1> <p>akajs 是为 Kalengo 定制的。</p> <p>比如 akajs 是基于 koa 做包装而不是 express，原因是因为我们对 Koa 更熟悉</p> <p>又比如 akajs 暂时只支持 mongodb，因为我们公司业务 mongodb 就足够支撑了。</p> <p>akajs 并不适合所有项目，但是它可以给你一个参考</p> <ul><li>如何包装 mongoose</li> <li>如何校验参数和处理全局异常</li> <li>如何集成 IOC</li> <li>如何做集成测试
等等</li></ul> <h1 id="quickstart"><a href="#quickstart" class="header-anchor">#</a> QuickStart</h1> <p>我们提供了一个脚手架模板，使用 klg-init 工具来初始化项目，如果没有 klg-init, 请先安装</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">npm</span> i klg-init -g
</code></pre></div><p>创建项目</p> <div class="language-bash extra-class"><pre class="language-bash"><code>$ <span class="token function">mkdir</span> aka-example <span class="token operator">&&</span> <span class="token builtin class-name">cd</span> aka-example
$ klg-init <span class="token builtin class-name">.</span> --type<span class="token operator">=</span>project-ts
$ <span class="token function">npm</span> i
</code></pre></div><p>启动项目:</p> <div class="language-bash extra-class"><pre class="language-bash"><code>$ <span class="token function">npm</span> run dev
$ <span class="token function">open</span> http://localhost:3000
</code></pre></div></div> <footer class="page-edit"><!----> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/akajs_doc/" class="prev router-link-active">Home</a></span> <span class="next"><a href="/akajs_doc/guide.html">指南</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/akajs_doc/assets/js/app.0fa76309.js" defer></script><script src="/akajs_doc/assets/js/2.4bdd5d90.js" defer></script><script src="/akajs_doc/assets/js/8.b8622590.js" defer></script>
</body>
</html>