npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

koa2-rest-cli

v0.6.1

Published

A RESTFul API generator for Koa2

Downloads

15

Readme

koa2-rest-cli

Build Status npm version ndoe version github tag monthly downloads license contributions welcome

Koa application generator.

Generating a RESTFul Koa2 template with koa2-rest-cli.

Inspired by koa-generator.

Features

  • Support TypeScript with es6 class
  • Support koa 2.x(koa middleware supported, need Node.js 7.6+ , babel optional)
  • Generate RESTFul API ONLY

Requirements

| Item | Details | | ----------- | ------------------------------------------------------------ | | System | GNU/Linux (>=2.6.x), macOS (>=10.10.x), Windows (later than XP) | | Environment | Node.js and npm |

Installation

$ npm install -g koa2-rest-cli

with 1 command

  • koa2-init (Support koa 2.x ONLY)

Command Line Options

This generator can also be further configured with the following command line flags.

Usage: koa2-init [options] [project_name(dir)]

Options:
  -V, --version     output the version number
  -t, --typescript  add typescript support
  -f, --force       force generate in an empty directory
  -h, --help        output usage information

Quick Start

To get started in the quickest way, after you installed this package, the system will auto link script koa2-init to a directory that in your system's $PATH. Thus you can simply run the command as shown below:

Create the App

Without TypeScript

$ koa2-init test

With TypeScipt

$ koa2-init -t test

# or

$ koa2-init --typescript test

then the process will auto execute npm install command in your project directory.

Start the Project

Without TypeScript

# start a dev server
$ npm run dev

# start a production server
$ npm run prod
# (production server requires pm2)

With TypeScript

# start a dev server
$ npm start

# start a production server
$ npm run serve
# (production server requires pm2)

# build the project
$ npm run build

# clean the project
$ npm run clean

# lint the project
$ npm run lint

the application will start and listen on *:3000.

License

MIT