Name: kyt
Owner: The New York Times
Description: Starting a new JS app? Build, test and run advanced apps with kyt ?
Created: 2016-06-03 19:16:26.0
Updated: 2018-05-23 20:37:27.0
Pushed: 2018-05-23 20:37:31.0
Homepage: https://open.nytimes.com/introducing-kyt-our-web-app-configuration-toolkit-9ccddf6f6988
Size: 2661
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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.
npm install -g kyt-clikyt-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 devhttp://localhost:3000kyt 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.
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.
In an attempt to gather feedback to set future priorities, we're running a brief user survey asking: what are you using modifyWebpackConfig for?
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.
kyt-cli setup
See the kyt-cli documentation for more details.
kyt includes a command line program with all the commands needed for development.
Running kyt-cli setup includes these commands as scripts in your package.json:
run dev
Or you can run a command using node_modules/.bin/kyt command:
_modules/.bin/kyt build
Here are the available commands:
dev starts a development environmentbuild compiles server and client code for production usetest runs all tests in /srcproto starts the prototyping applint lints src code using ESLintlint-style lints src code using Stylelinthelp shows commands and their documentationSee our CLI docs for further details.
kyt follows a few simple conventions.
All projects must have the following structure:
c/
client/
index.js
server/
index.js
Each index.js file acts as the build entry.
(Note that server/index.js is not required if hasServer is 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 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.
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.
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