Every sizable JavaScript web app needs a common foundation: a setup to build, run, test and lint your code. kyt is a toolkit that encapsulates and manages the configuration for web apps.
Read more about kyt in our blog post.
- Install Node.js (v6.0+ required).
- Create a directory with a package.json file
npm install --save kyt
node_modules/.bin/kyt 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
http://localhost:3000
We recommend installing kyt as a dependency in your project.
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.
- CSS Module and SASS support
- Inline SVG support
- Style and script linter rulesets
- A pre-configured test runner with Jest
Developers design their own architecture, choosing the tools they need for rendering, styling, and handling data.
For advanced use cases, kyt enables developers to add additional tools and configuration. See our config override instructions for details, and our recipes for examples.
kyt includes a command line program with all the commands needed for development.
setup
includes these commands as scripts in your package.json:
npm run dev
Or you can run a command using node_modules/.bin/kyt command
node_modules/.bin/kyt build
setup
sets up kyt and installs a starter-kytdev
starts a development environmentbuild
compiles server and client code for production usestart
runs production codetest
runs all tests in /srcproto
starts the prototyping applint
lints src code using ESLintlint-style
lints src code using Stylelinthelp
shows 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
Each index.js
file acts as the build entry.
If you're setting up a new project our full list of conventions.
kyt allows you to specify options in a kyt.config.js
file.
See the kyt config docs for instructions.
kyt uses Webpack to compile src code and run tests. See our recipes for extending configuration.
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 includes a setup
command which installs any preconfigured starter-kyt git repository, adding additional dependencies and building a source directory.
See our recommended list of starter-kyts
Community supported starter-kyts can be built to support a variety of projects. See additional info on how to build a starter-kyt.
Want to help? See details here