# create-koa-application

> Structured boilerplate to create your Node app with Koa.js.

Latest version **1.0.7** (published 2019-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-koa-application
pnpm add create-koa-application
yarn add create-koa-application
bun add create-koa-application
```

Provides the command `create-koa-application`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-05-27 |
| First published | 2019-05-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 5 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 76 |
| Author | Marco Antonio Ghiani |
| Maintainers | m_a_g |
| Keywords | Node, Koa, create, boilerplate, template |

## Links

- npm: https://www.npmjs.com/package/create-koa-application
- Repository: https://github.com/marcoantonioghiani01/create-koa-app
- Homepage: https://github.com/marcoantonioghiani01/create-koa-application#readme
- Issues: https://github.com/marcoantonioghiani01/create-koa-application/issues
- npm.io page: https://npm.io/package/create-koa-application

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) 2.4.2
- [figlet](https://npm.io/package/figlet.md) 1.2.1
- [commander](https://npm.io/package/commander.md) 2.20.0
- [cli-spinner](https://npm.io/package/cli-spinner.md) 0.2.10
- [download-git-repo](https://npm.io/package/download-git-repo.md) 1.1.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2019-05-27
- 1.0.6 — 2019-05-24
- 1.0.5 — 2019-05-24
- 1.0.4 — 2019-05-24
- 1.0.2 — 2019-05-24
- 1.0.1 — 2019-05-23
- 1.0.0 — 2019-05-23

## README

# Create Koa Application
[![npm version](https://img.shields.io/npm/v/create-koa-application.svg)](https://www.npmjs.com/package/create-koa-application) [![license](https://img.shields.io/github/license/marcoantonioghiani01/create-koa-application.svg)](https://github.com/marcoantonioghiani01/create-koa-application/blob/master/LICENSE) 
> 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.

<p align='center'>
  <img src='https://unpkg.com/create-koa-application@1.0.5/assets/creation.svg' width='600' alt=''>
</p>

## Table of contents

* [Requirements](#requirements)
* [Installation](#installation)
* [Usage](#usage)
* [Project structure](#project-structure)
* [Contributors](#contributors)
* [License](#license)

## Requirements

 * **[Node](https://nodejs.org/) 8 or later.**
 * [Npm](https://www.npmjs.com/)

## Installation

#### npm

To install globally the tool:

```bash
npm install -g create-koa-application
```

#### npx

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

```bash
npx create-koa-application <project-name>
```

## Usage

Create a new application running on your terminal:

```bash
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
├── .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](https://github.com/marcoantonioghiani01) - [LinkedIn](https://www.linkedin.com/in/marcoantonioghiani/)

## License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/marcoantonioghiani01/create-koa-application/blob/master/LICENSE) file for details.

---
_Source: https://npm.io/package/create-koa-application · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._