Starterkyts.md

Starter-kyts

The following is a guide for building starter-kyts. If you would like to know more about installing a starter-kyt, check out the kyt-cli setup tool.

How to build a starter-kyt

starter-kyts act as boilerplates for projects. They use kyt as their build system and add additional source code and tools.

1. Choose your starter-kyt architecture. Make sure you are familiar with the kyt conventions.

2. Add additional dependencies to a package.json

3. Set up /src/client/index.js and /src/server/index.js (the latter is optional if hasServer: false is set in config)

4. Optionally add a package.json kyt object configuration with the following keys and values:

   • version (default: undefined) - use this to lock down the starter-kyt kyt dependency version. This should be in value/range semver form.
   • files (default: []) - an array of files/paths to copy into a user's project. The entire src/ directory will always be copied.
   • scripts (default: []) - an array of package.json script names to copy into the user's package.json scripts.

   # package.json
   {
     ...
     "scripts": {
       "typings": "typings install",
       "lint": "npm run tslint 'src/**/*.ts'"
     },
     "kyt": {
       "version": "0.0.1",
       "files": ["tsconfig.json", "tslint.json", "typings.json", ".gitignore"],
       "scripts": ["typings", "lint"]
     },
     ...
   }
   

5. Create documentation

6. Submit to kyt to be considered as a recommended starter-kyt