kolibrejsdeprecated

[![Build Status](https://travis-ci.org/zhengxs2018/kolibrejs.svg?branch=master)](https://travis-ci.org/zhengxs2018/kolibrejs) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prett

Usage no npm install needed!

<script type="module">
  import kolibrejs from 'https://cdn.skypack.dev/kolibrejs';
</script>

README

KolibreJS

Build Status code style: prettier npm version Downloads

本项目不建议用于生产环境使用,推荐互相学习,一起学 typescript + nodejs。

灵感来源于 eggjsmidwayjs, 基于 koa 开发,运行在 nodejs 上的网络框架。

安装

$ npm install kolibrejs --save

使用

import "reflect-metadata"

import { Kolibre } from 'kolibrejs'

const app = new Kolibre(__dirname)

app.router.get('/', ctx => {
  ctx.body = 'hello, world'
})

app.run(8080, function onReady() {
  console.log('Listen on http://localhost:8080')
})

启动项目

你需要安装 node.js 的版本为 nodejs >= 8.0

克隆此仓库后运行:

# 安装依赖,推荐使用 yarn 安装
$ npm install

# 启动 example 服务
$ npm run dev

# 启动文档编辑模式
$ npm run docs:dev

# 构建文档静态页
$ npm run docs:build

package.json 文件的 scripts 部分还有一些其他脚本可用.

开发计划

框架层 kolibrejs

  • Kolibre 框架主体
  • PluginManager 插件管理器

核心 @kolibrejs/core

  • Application 应用主体
  • Runtime 当前运行环境

内置模块 @kolibrejs/builtin

  • Tasks 微任务管理
  • Finder 文件模糊查找
  • Loader 模块加载器

内置插件 @kolibrejs/internal-plugins

  • config 多环境配置
  • controller 发现并自动注册控制器
  • service 发现并自动注册服务
  • extend 拓展应用原型链
  • And more

拓展模块

  • @kolibrejs/logging
  • @kolibrejs/shared

引入了 微软的 tsyringe 依赖注入插件,但是还需要一些时间学习

版本发布

# 更新版本号,内置代码检查
$ npm version <new_version|major|minor|patch>

# 发布代码包,自动代码
$ npm publish

可使用 npm version --help 查看帮助信息

感谢

感谢这些开源贡献给予的灵感,以下排名不分先后。