README.md

Create Koa Application

A structured boilerplate to create your Node app with Koa.js.

Welcome to Koa.js

Create Koa Application is a cli tool to bootstrap a Koa.js application with a good environment preset and an alternative folder structure.

Table of contents

• Requirements
• Installation
• Usage
• Project structure
• Contributors
• License

Requirements

• Node 8 or later.
• Npm

Installation

npm

To install globally the tool:

npm install -g create-koa-application

npx

Alternatively, you can use it with npx to create a new project:

npx create-koa-application <project-name>

Usage

Create a new application running on your terminal:

Installed Globally

create-koa-application <project-name>

npm

npm init koa-application <project-name>

yarn

yarn create koa-application <project-name>

After your project is correctly initialized

Project structure

<project-name>
├── node_modules
├── index.js
├── server.js
├── package.json
├── package-lock.json
├── README.md
├── .env.example
├── .eslintrc.js
├── .eslintignore
├── .gitignore
├── .huskyrc
├── .prettierrc
├── .prettierignore
├── api
│   ├── users
│   │   ├── index.js
│   │   ├── user.routes.js
│   │   └── user.controller.js
│   ├── otherApiFolder
│   ├── ...
│   └── index.js
├── config
│   ├── components
│   │   ├── database.config.js
│   │   └── server.config.js
│   └── index.js
└── middleware
    └── error.middleware.js
└── utils
    └── generateId.util.js

Contributors

• Marco Antonio Ghiani - GitHub - LinkedIn

License

This project is licensed under the MIT License - see the LICENSE.md file for details.