Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
defaults
test
.gitignore
.travis.yml
LICENCE
README.md
create.js
package.json
publish.js

README.md

nstart

Project creation and publishing

Example

Docs

Usage:

  nstart create <project> <description> <[options]> -- <tags ...>

    Use nstart to create a project for you. Given a project and a
      description it will use `npm-proj` to create a folder
      directory. You can edit the `~/.npm-proj/` template to
      change the default scaffolding.
    The project get's used to create a folder project and is used
      in the project scaffolding, the description is also used in
      the scaffolding.
    You can pass a space seperated list of tags after the `--`
    You can also pass in options for travis/testling/git/github/file.

    Options:
      -c [--conflict]         Check npm for project name conflicts
      -a [--travis] <Bool>    Enable creation of travis.ci hook
      -t [--testling] <Bool>  Enable creation of testling hook
      -g [--github] <Bool>    Initialize a github repo & commit it
      -f [--file] <file path> Location of code to copy to ./index.js

  nstart publish <[options]>

    Use nstart to publish the current project you are in. You
      can pass in options to do the git, github, travis and
      testling flows. After it has done those it will run npm
      publish.
    Note: You shouldn't run the git/github/travis/testling steps
      if you have already run them in the `nstart create` step

    Options:
      -g [--github] <Bool>    Initialize a github repo & commit it
      -a [--travis] <Bool>    Enable creation of travis.ci hook
      -t [--testling] <Bool>  Enable creation of testling hook

Configuring the config for nstart and npm-proj

You can go into ~/.npm-proj to tweak the scaffolding template to your liking!

You can go to ~/.nstart/config.json to tweak the config to your liking!

The default config is

{
  create: {
    github: false
  },
  publish: {
    github: false
  }
}

You should change the keys to true so that they default to being on without setting the flag in the CLI. If you want to disable them for individual calls then do nstart create -a false

I recommend one of two flows:

Create & github + code + publish

Create your project, push to github, then write code then publish it

{
  create: {
    github: true,
    conflict: true
  },
  publish: {
    github: false
  }
}

Create + code + github & publish

Create your project, write some code, then push to github & publish it

{
  create: {
    github: false
  },
  publish: {
    github: true
  }
}

Installation

npm install nstart

Contributors

  • Raynos

MIT Licenced

Something went wrong with that request. Please try again.