create-koa-application - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #typescript #llm #golang #go #deep-learning #linux #macos #awesome #kubernetes #vue

create-koa-application

(★ 76)

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

File Explorer

Download Latest Version (.zip)

- creation.svg
- chalk.js
- files.js
- deploy.sh
- applyPatch.js
- checkConnection.js
- cloneTemplate.js
- createLogo.js
- createProgram.js
- createSpinner.js
- index.js
- initGit.js
- installDependencies.js
- welcome.js
.gitignore
CONTRIBUTING.md
create-koa-application.js
index.js
LICENSE
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/tonyghiani/create-koa-application

Downloads the entire project code from GitHub to your computer.

cd create-koa-application

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g create-koa-application

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g create-koa-application

Installs the package published on the npm registry globally — no need to clone the source.

npm init koa-application <project-name>

Type this command into your terminal and run it.

yarn create koa-application <project-name>

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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:

### Installed Globally

```bash
create-koa-application <project-name>
```
### npm

```bash
npm init koa-application <project-name>
```

### yarn

```bash
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](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.