Skip to content

TypeScript-Web-Framework/twf-cli

Repository files navigation

dependencies Status Known Vulnerabilities Maintainability Documentation Status Build Status npm version Greenkeeper badge

TypeScript Web Framework Command Line Interface

TypeScript Web Framework CLI

Features

  • Create project
    • Current Directory
    • Own Directory
  • Generate API Controller
    • Default CRUD
      • @HttpPost create()
      • @HttpGet read()
      • @HttpPut update()
      • @HttpDelete delete()
  • Remove API Controller
  • Verify project structure
    • Verify existing www
    • Verify existing package.json
    • Verify existing src
    • Verify existing src/manifiest.json
    • Verify existing src/controllers
    • Verify existing src/annotations
    • Verify existing src/core
    • Verify existing src/app.ts
    • Verify existing src/server.ts
    • Verify existing src/typings.d.ts
  • Version info & comparison
    • CLI Version
    • Project Version
    • Node Version
    • NPM Version
  • Clean project
    • Remove www
    • Remove dist
    • Remove temp
    • Remove node_modules
    • Remove package-lock.json
  • Install dependencies
  • Serve project
  • Generate http property on controller
  • Remove http property on controller
  • Test Project(Unit Testing)
  • Build Project
  • Generate compiled binary package
    • Windows
    • Linux
    • OSX

Commands

Start Project

To start a new project on current directory you don't need set project name

!IMPORTANT

twf-cli does not interpret . or ...

twf start

To start a new project on with a own directory you need set project name

twf start MyProject

Clean Project

twf clean

Install Dependencies

twf install

Verify Project

twf verify

Serve

twf serve

Generate Controller

# twf add controller [name] [default route]
twf add controller index
twf add controller index /profile/:id
twf add controller main/index /profile/:id