��
koa-starter
A starter kit for a slightly opinionated Koa project.
Opinions
I built this Koa starter kit because there's a number of packages I like to use when starting a new project. The major ones are:
I'm also including goodies from:
Prerequisites
- Node.js (Version 8 and up recommended, async/await support required)
- Github Client ID and Secret (for OAuth)
- Auth0 Account (for OAuth)
Installation
- Clone down the repository.
git clone https://github.com/snollygolly/koa-starter.git
- Install packages (from inside the koa-starter folder).
npm install
Create your config. There's a
config.example.jsonfile in the root. Edit it to include all your values for the site and your OAuth information. Save it asconfig.jsonand leave it in the root.If you want to use Google Analytics, set
config.site.analyticsto your Tracking ID and make sure the analytics partial (analytics.hbs) contains the correct Universal Analytics tracking code. If you don't want to use Google Analytics, remove that property or set it to false.Start it up.
npm start
- Enjoy!
Extras
While koa-starter isn't a framework, I've added a few small extras to make getting your project up and started as easy as possible.
Including assets from view rendering
When you render you view, you can use the following properties to link to assets.
- Scripts: This array contains scripts living in
/assets/jsthat you'd like to link to. The.jswill be added for you.
await ctx.render("index", {
title: config.site.name,
user: user,
scripts: ["index", "extra"]
});
- Vendor JavaScript: This array contains links to external files you'd like to link to. The
.jswill not be added for you.
await ctx.render("index", {
title: config.site.name,
user: user,
vendor_js: ["http://vendor.com/cdn/lib.min.js"]
});
- Vendor CSS: This array contains links to external files you'd like to link to. The
.csswill not be added for you.
await ctx.render("index", {
title: config.site.name,
user: user,
vendor_css: ["http://vendor.com/cdn/lib.min.css"]
});
Error Handling
Thrown errors are caught in the error handling middleware in index.js. By default, all errors will render the error.hbs view with information about the error. It's possible to set ctx.state.api equal to true in the controller to tell the error handling middleware that this route is an API endpoint, and the error should be sent in JSON instead of rendered as a view.
-
从零开始实现一个koa-starter（二） 本节目标 本节目标是实现一个简单的路由自动装载服务端，包含完整装载日志，请求日志，自动绑定controller到路由，只需按照抽象类书写controller即可。先上【GitHub地址】 应用服务的基本封装 什么是koa？ Koa 是下一代的 Node.js 的 Web 框架。由 Express 团队设计。旨在提供一个更小型、更富有表现力、更可靠的 W
-
本节目标 本节【GitHub地址】,本篇主要目标时熟悉typescript的装饰器，以及学习使用装饰器，并且将基于装饰器，改造koa-router路由自动装载功能。 ts装饰器 typescript装饰器官方文档 装饰器是一种特殊类型的声明，它能够被附加到类声明，方法， 访问符，属性或参数上。 装饰器使用 @expression这种形式，expression求值后必须为一个函数，它会在运行时被调用
-
从零开始实现一个koa-starter（一） 背景 为什么会有这样的想法呢？原因其实很简单就是单纯想要完整的实现一次node服务开发的链路，总结下自己所掌握的东西。另外一个呢，最近都在学习使用Typescript，所以索性基于TS实现一个服务端的代码，也是方便自己总结。 需求简述 我的目的是最终实现一个类似nest的简易starter，它包含的内容如下： 1.基于koa的完整restful api
-
本节目标 本节目标是实现一个简单的路由自动装载服务端，包含完整装载日志，请求日志，自动绑定controller到路由，只需按照抽象类书写controller即可。先上【GitHub地址】 应用服务的基本封装 什么是koa？ Koa 是下一代的 Node.js 的 Web 框架。由 Express 团队设计。旨在提供一个更小型、更富有表现力、更可靠的 Web 应用和 API 的开发基础。它的特点是优
-
ejs 安装 npm install --save ejs koa-views 引入 const views = require("koa-views") app.use(views("views",{extension:"ejs"})) 注意：上面这里意思就是把路径 views 作为存放 ejs 模板的路径。 基本使用 router.get("/news",async (ctx,next)
-
Koa art-template view render middleware. support all feature of art-template. Install npm install --save art-template npm install --save koa-art-template Example const Koa = require('koa'); const ren
-
koa是Express的下一代基于Node.js的web框架，目前有1.x和2.0两个版本。 历史 1. Express Express是第一代最流行的web框架，它对Node.js的http进行了封装，用起来如下： var express = require('express'); var app = express(); app.get('/', function (req, res) {
-
Koa 是下一代的 Node.js 的 Web 框架。由 Express 团队设计。旨在提供一个更小型、更富有表现力、更可靠的 Web 应用和 API 的开发基础。 Koa可以通过生成器摆脱回调，极大地改进错误处理。Koa核心不绑定任何中间件，但提供了优雅的一组可以快速和愉悦地编写服务器应用的方法。 示例代码： var koa = require('koa');var app = koa();//
-
Koa - HelloWorld 以上便是全部了，我们重点来看示例，我们只注册一个中间件, Hello Worler Server： <?php $app = new Application(); // ... $app->υse(function(Context $ctx) { $ctx->status = 200; $ctx->body = "<h1>Hello Worl
-
koa-log4js A wrapper for log4js-node which support Koa logger middleware.Log message is forked from Express (Connect) logger file. Note This branch is use to Koa v2.x.To use Koa v0.x & v1.x, please ch
-
koa-rudy 环境 node -v >=6.9.0pm2 启动 npm install npm run dev 开发环境 npm run dev || test || prod 接口测试 npm run mocha 推荐开发工具 vscode 实现 支持 async/await MVC架构（middleware-view-controller） RESTful a