Read more about kyt in our blog post.
Upgrading to 0.4.0
- Install Node.js (v6.0+ required).
npm install -g kyt-cli
kyt-cli setup- This will set up your project with application and configuration files so that you can get started with kyt. Learn more about setup.
npm run dev
- Check out
How it Works
kyt manages configuration for all aspects of development. It can be installed as an npm dependency into a new or existing project. kyt’s goal is to encapsulate only development tools, giving users the freedom to control their source directory and make important decisions about app architecture. kyt provides a command line interface for running all development tools.
kyt's base features include:
- A Node server provided for rendering front-end page requests
- Client and server hot reloading
- ES-Latest stable features using Babel and babel-polyfill
- CSS Module and SASS support
- Inline SVG support
- Style and script linter rulesets
- A pre-configured test runner with Jest
- Optional client-only mode for apps that already have a server
Developers design their own architecture, choosing the tools they need for rendering, styling, and handling data.
Setting up a kyt project
kyt-cli is a utility for bootstrapping kyt projects. It can be installed globally and run to create a new project or integrate kyt with an existing project.
See the kyt-cli documentation for more details.
kyt includes a command line program with all the commands needed for development.
kyt-cli setup includes these commands as scripts in your package.json:
npm run dev
Or you can run a command using
Here are the available commands:
devstarts a development environment
buildcompiles server and client code for production use
startruns production code
testruns all tests in /src
protostarts the prototyping app
lintlints src code using ESLint
lint-stylelints src code using Stylelint
helpshows commands and their documentation
See our CLI docs for further details.
kyt follows a few simple conventions.
All projects must have the following structure:
src/ client/ index.js server/ index.js
index.js file acts as the build entry.
server/index.js is not required if
false in config).
If you're setting up a new project see our full list of conventions.
kyt allows you to specify options in a
See the kyt config docs for instructions.
kyt uses Webpack to compile src code and run tests. See our recipes for extending configuration.
To configure Babel, kyt respects
.babelrc files defined at the root of user projects, and provides presets to provide opinionated configurations. (If no
.babelrc is defined in the user project,
babel-preset-kyt-core is used.)
While kyt can be easily integrated into new or existing Node projects, it is even more powerful when used with a starter-kyt. A starter-kyt offers the benefits of boilerplates while minimizing the amount of new tools to learn and maintain. The
kyt-cli setup command installs any preconfigured starter-kyt git repository, adding additional dependencies and building a source directory.
See our recommended list of starter-kyts.
How to build a starter-kyt
Community supported starter-kyts can be built to support a variety of projects. See additional info on how to build a starter-kyt.
How to contribute to kyt
Want to help? See details here