@kingofcramers/create v1.0.27

Create-Project CLI

This is the command line tool that I've built to help me get up and running with my various projects (Typescript blank builds, webscrapers, Golang projects, and so forth) much more quickly.

Installation

npm i --global @kingofcramers/create-project

Development

npm run dev

The tyescript compiler will automatically rebuild the files into the ./dist folder. To run the command locally, link it:

npm link

Then you can run the binary outside of the project folder. When you're done developing, run npm unlink

Git

Normal git workflow. Add, commit, and push changes

Publishing to NPM

NOTE: Only maintainers can publish changes.

1. Make changes.
2. git add .
3. git commit -m "Changed functionality."
4. npm version patch/major/minor --message "Upgraded to %s" (This will update the package.json file and make another commit, replacing %s with the version.)
5. git push
6. npm publish (this will trigger our build/postbuild scripts)

This will trigger the prepublish script which will rebuild the CLI into the ./dist folder. Then the postbuild script will copy over any new resources before publishing.

Usage

create-project -n <foldername> -k <kind> [...flags]

Options:
      --help              Show help                                    [boolean]
      --version           Show version number                          [boolean]
  -n, --name              sets name of project
  -k, --kind              sets overall kind of project
                                           [choices: "react", "scraper", "node"]
      --typescript, --ts  adds typescript                              [boolean]
  -d, --docker            adds dockerfile                              [boolean]
  -p, --npm               installs npm packages                          [array]

Examples:
  create-project demo --type=react --ts     creates a new react project 'demo'
                                            with typescript configured
  create-project demo --type=scraper        creates a new webscraper project
  -docker                                   with typescript configured