Giter VIP home page Giter VIP logo

nstarter's Introduction

nstarter - A Node.js Project Template Starter

nstarter is a CLI project starter for Node.js projects. You can pack your tools/packages/libs/modules/code-block into a single template project, and use nstarter to initiate a similiar project everywhere.

โš  This tool is currently for private testing only.

Requirements

  • node.js >= 8.0
  • npm >= 4.0
  • git

Install

npm install -g nstarter

Usage

nstarter [target]

CLI tools to deploy TypeScript project.

Commands:
  nstarter [target]                  CLI tools to deploy TypeScript project.
                                                                       [default]
  nstarter config set <key> <value>  Config template starter options.
  nstarter update template           Update local template cache.
  nstarter clean                     Clear local template cache.

Positionals:
  target  Target deploy path.                                           [string]

Options:
  --help         Show help                                             [boolean]
  --version      Show version number                                   [boolean]
  --name         Project name.                                          [string]
  --verbose, -v  Show debug info.                                      [boolean]

As nstarter started, an interactive CLI will ask more options to initiate a new project.

The local template project cache will be cloned at ~/.nstarter/_template/ while running nstarter for the first time.

Config

nstarter config set <key> <value>

Config template starter options.

Positionals:
  key    The key to set value at.                            [string] [required]
  value  The value to set.                                   [string] [required]

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

Here are supported configurations to set by this command.

Settings Type Description
template string Git repository url of the target template project.

The local config file will be located at ~/.nstarter/config.json.

Templating

You can always create a new custom template project following the templating rule of nstarter. A template project could pack whatever libraries/stack/code/document/structure which you need to start with, and can be build into your personal swiss army knife to generate new projects.

For details to create your own project template, please read more about templating.

License

MIT


Made on ๐ŸŒ with ๐Ÿ’“.

nstarter's People

Contributors

huhamhire avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.