A starter kit for a slightly opinionated Koa project.
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:
- Node.js (Version 5 and up recommended)
- Github Client ID and Secret (for OAuth)
- 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.json.example
file in the root. Edit it to include all your values for the site and your OAuth information. Save it asconfig.json
and leave it in the root. -
If you want to use Google Analytics, set
config.site.analytics
to 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!