Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.4.0 docs #338

Merged
merged 75 commits into from
Feb 13, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
41b4e65
moving to packages
ccpricenytimes Oct 29, 2016
be35691
separating setup into kyt-cli; creating kyt-utils for shared utilitie…
ccpricenytimes Oct 30, 2016
18343c2
set up linting and testing, check versions of packages in setup
ccpricenytimes Oct 30, 2016
a08f76e
tests and e2e tests can now be run from root, eslint not working
ccpricenytimes Oct 30, 2016
d1cc392
moving node version check into a util
ccpricenytimes Oct 30, 2016
deb15ad
change dependency back to latest version from npm
ccpricenytimes Oct 30, 2016
6365996
Adding list selection of starter-kyts
ccpricenytimes Nov 4, 2016
cb68175
updating start command
ccpricenytimes Nov 7, 2016
5a5b6f7
moving kyt-starter-universal
ccpricenytimes Nov 12, 2016
2c4f95f
copying starter-kyt
ccpricenytimes Nov 12, 2016
0bd4a90
adding starter-static, updating starter-universal name
ccpricenytimes Nov 13, 2016
896b09e
setup with static; currently kytconfig is getting installed twice...
ccpricenytimes Nov 13, 2016
96a97f6
removing kyt.config.js from list of files, in static so it doesnt get…
ccpricenytimes Nov 19, 2016
cf39d5b
typo
ccpricenytimes Nov 19, 2016
ea90fd7
merging in master
ccpricenytimes Nov 21, 2016
e501d8f
adding ability to create new directory as part of setup
ccpricenytimes Nov 22, 2016
5d21bd4
updatinG top level lint commanD
ccpricenytimes Nov 23, 2016
d1c9c46
moving enzyme to devDependencies for testing
ccpricenytimes Nov 23, 2016
f00a57e
lint
ccpricenytimes Nov 23, 2016
30debd5
sync up eslint dependencies; changelog docs; moving some starter-kyt …
ccpricenytimes Nov 23, 2016
d67a1e5
updating travis command
ccpricenytimes Nov 23, 2016
72be9f3
more &&
ccpricenytimes Nov 23, 2016
cc655d4
Merge branch 'master' into monorepo
ccpricenytimes Dec 3, 2016
7ca1266
cleanup; kyt now gets added as a devDepency in existingProjectSetup
ccpricenytimes Dec 3, 2016
1a60ffc
Updated docs for monorepo
ccpricenytimes Dec 3, 2016
5700ddb
adds kyt start deprecation command
ccpricenytimes Dec 4, 2016
023b684
updating logging for setup; version check will now be based off depen…
ccpricenytimes Dec 7, 2016
b0ec1a7
code review feedback
ccpricenytimes Dec 9, 2016
0dd30ea
Merge branch 'master' into monorepo
ccpricenytimes Dec 9, 2016
fcfe47c
prepping kyt-utils for prepublish
ccpricenytimes Dec 9, 2016
30faa6d
update utils package.json
delambo Dec 9, 2016
5b7a365
update kyt-utils to point to npm
ccpricenytimes Dec 9, 2016
b8489c0
removing branch specific code and changing cli version to alpha to pr…
ccpricenytimes Dec 9, 2016
99d3401
Merge branch 'monorepo' of github.com:NYTimes/kyt into monorepo
delambo Dec 9, 2016
858ce72
moves package.json.scripts.lint to top level package.json
delambo Dec 9, 2016
3e8f51c
eslint from kyt-core
delambo Dec 9, 2016
153f2e2
Merge branch 'monorepo' into monorepo-docs
ccpricenytimes Dec 10, 2016
352b804
merge conflicts
ccpricenytimes Dec 10, 2016
7f98487
docs for new linting commands
ccpricenytimes Dec 10, 2016
a1634c0
Merge branch 'master' into monorepo-docs
ccpricenytimes Dec 13, 2016
d4cf159
Adding kyt-cli list docs
ccpricenytimes Dec 13, 2016
4045eb4
Merge branch 'master' into monorepo-docs
Dec 16, 2016
93033e7
create readme for kyt-core babel preset
jaredmcdonald Dec 16, 2016
11ea7be
create readme for babel-preset-kyt-react
jaredmcdonald Dec 16, 2016
283b8ff
Update README.md
jaredmcdonald Dec 16, 2016
89a4278
Update README.md
jaredmcdonald Dec 16, 2016
cc5d83b
Update README.md
jaredmcdonald Dec 16, 2016
7754e74
Update README.md
jaredmcdonald Dec 16, 2016
b7e781a
Update README.md
jaredmcdonald Dec 16, 2016
b7f7066
Update Recipes.md
jaredmcdonald Dec 16, 2016
29c031b
Update
jaredmcdonald Dec 16, 2016
8b0d4d0
Update Recipes.md
jaredmcdonald Dec 16, 2016
8fce438
Merge branch 'master' into monorepo-docs
ccpricenytimes Dec 21, 2016
0f7c59c
Merge branch 'monorepo-docs' of github.com:NYTimes/kyt into monorepo-…
ccpricenytimes Dec 21, 2016
ea50282
docs cleanup
ccpricenytimes Dec 21, 2016
d81c04c
Adds changelog; adds additional contributing docs about setting up lo…
ccpricenytimes Dec 26, 2016
507d183
document -k option in kyt-cli setup
ccpricenytimes Jan 2, 2017
6ce45c9
adds linter docs
delambo Jan 8, 2017
9270d79
Adds yarn docs
tizmagik Jan 10, 2017
c2f7d27
Merge branch 'master' into monorepo-docs
ccpricenytimes Jan 10, 2017
0aa5c63
Adding yarn to the changelog
ccpricenytimes Jan 10, 2017
c34266e
add bugfix to changelog
ccpricenytimes Jan 14, 2017
0641a3c
Migration guide for 0.4.0
ccpricenytimes Jan 28, 2017
ff0f03b
adds linter packages section
ccpricenytimes Jan 28, 2017
366a2de
separates kyt-cli changelog
delambo Feb 4, 2017
5f2ecf2
Merge branch 'master' into monorepo-docs
delambo Feb 7, 2017
a06a290
updates linter docs for version 0.2.0
delambo Feb 7, 2017
04b10f0
Merge branch 'master' into monorepo-docs
ccpricenytimes Feb 7, 2017
c9012b7
Updating docs for interactive setup
ccpricenytimes Feb 7, 2017
d463cba
updates for interactive kyt-cli
ccpricenytimes Feb 7, 2017
df4dac1
Merge branch 'master' into monorepo-docs
ccpricenytimes Feb 8, 2017
968dcfe
update migration guide
ccpricenytimes Feb 8, 2017
6c2bc74
Merge branch 'master' into monorepo-docs
ccpricenytimes Feb 12, 2017
036696b
Merge branch 'monorepo-docs' of github.com:NYTimes/kyt into monorepo-…
ccpricenytimes Feb 12, 2017
a503860
Docs updates
ccpricenytimes Feb 12, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updating docs for interactive setup
  • Loading branch information
ccpricenytimes committed Feb 7, 2017
commit c9012b7cdcbee7fe06c6d620010a266188fcb5f5
22 changes: 14 additions & 8 deletions docs/kytCli.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,31 @@ The `setup` command sets up your project with all the application files that you

If kyt finds any files with duplicate names, it will back up your file before replacing it.

`setup` takes the following optional commands:
`setup` takes you through the process of creating a new kyt project with a set of interactive questions. If you wish to automate this process you can use these optional flags:

- `-d` The name of the new project directory. If not specified kyt will install the project in your current working directory.
- `-r` The Github url for a starter-kyt. If not specified you will be prompted to select a starter-kyt from the supported list.
- `-k` For local development purposes, you can override the version of kyt to be installed by passing in a new version number or a file path eg. `file:../../my-local-kyt`
- `-p` The package manager to use, either `npm` or `yarn`. If not specified, defaults to `yarn` if it's installed globally, otherwise `npm` will be used.

### Setup a new project
`kyt-cli setup -d my-proj-name`
`kyt-cli setup`

kyt will provide you with a list of supported starter-kyts to install

The supported starter-kyts are:

- [kyt-starter-universal](/packages/starter-kyts/kyt-starter-universal)
- [kyt-starter-static](/packages/starter-kyts/kyt-starter-static)
- [kyt-starter-universal](/packages/kyt-starter-universal)
- [kyt-starter-static](/packages/kyt-starter-static)

### Setup a starter-kyt from github

`kyt-cli setup -d my-proj-name -r https://github.com/starter-kyt-repo.git`
`kyt-cli setup`
Select `I have my own url` when prompted to set up a starter-kyt

### Setup an existing project
Run `kyt-cli setup` in your project directory.
Select `no` when prompted to setup with a starter-kyt.
Select `I don't want a starter-kyt` when prompted to setup with a starter-kyt.


## `list` command
Expand All @@ -60,21 +61,26 @@ It includes:
#### [Universal React starter-kyt](/packages/starter-kyts/kyt-starter-universal)
This default starter-kyt is a good base for building advanced, universal React apps.

Install by running:
```
kyt-cli setup
```
and select `universal`

#### [Static starter-kyt](/packages/starter-kyts/kyt-starter-static)

This starter-kyt is for creating client side React apps.
Install by running:
```
kyt-cli setup -r https://github.com/NYTimes/kyt-starter-static.git
kyt-cli setup
```
and select `static`

#### [Universal Angular2 starter-kyt](https://github.com/delambo/kyt-starter-universal-angular2)
Still a work in progress, but this starter-kyt will serve as the base for building advanced, universal Angular2 apps.

```
kyt-cli setup -r https://github.com/delambo/kyt-starter-universal-angular2.git
kyt-cli setup
```
Select `I have my own url`
and paste https://github.com/delambo/kyt-starter-universal-angular2.git
16 changes: 10 additions & 6 deletions packages/kyt-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
# kyt-cli

kyt-cli is a util to create new kyt projects.

For more information see the [kyt-cli docs](/docs/kytCli.md)
kyt-cli is a tool for creating new kyt projects. It installs starter-kyts and all the tools you need to begin development.

## Quickstart

## Install kyt-cli
`npm install -g kyt-cli`

## Setup a new project
`kyt-cli setup -d my-proj-name`
`kyt-cli setup`

### Setup a starter-kyt from github

`kyt-cli setup -d my-proj-name -r https://github.com/starter-kyt-repo.git`
`kyt-cli setup`
Select `I have my own url` when prompted to set up a starter-kyt

## Setup an existing project
Run `kyt-cli setup` in your project directory.
Select `no` when prompted to setup with a starter-kyt.
Select `I don't want a starter-kyt` when prompted to setup.

## See a list of supported starter-kyts
`kyt-cli list`

For more information see the [kyt-cli docs](/docs/kytCli.md)