Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nytimes/kyt
Starting a new JS app? Build, test and run advanced apps with kyt 🔥
https://github.com/nytimes/kyt
Last synced: about 2 months ago
JSON representation
Starting a new JS app? Build, test and run advanced apps with kyt 🔥
- Host: GitHub
- URL: https://github.com/nytimes/kyt
- Owner: nytimes
- License: other
- Created: 2016-06-03T19:16:26.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T12:48:21.000Z (4 months ago)
- Last Synced: 2024-10-17T22:00:36.211Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://open.nytimes.com/introducing-kyt-our-web-app-configuration-toolkit-9ccddf6f6988
- Size: 7.96 MB
- Stars: 1,921
- Watchers: 31
- Forks: 109
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - kyt
README
# kyt
### Deprecation notice
This project is still used internally at the new york times but has long been deprecated. Please don't expect any support or documented releases going forward.
---
---
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](https://open.nytimes.com/introducing-kyt-our-web-app-configuration-toolkit-9ccddf6f6988).
[](https://david-dm.org/NYTimes/kyt) [](https://www.npmjs.com/package/kyt)
## Quick Start
1. Install [Node.js](https://nodejs.org/) (v14.0+ required). On Mac, this is as simple as:
```sh
brew install nvm
nvm use
```
1. `yarn add kyt`
1. `yarn 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](/packages/kyt-core/README.md).
1. `yarn dev`
1. Check out `http://localhost:3000`
## Features
- Isomorphic rendering of JavaScript apps
- Client and server hot-reloading in dev
- Babel presets for general ES6 support and React
- ESLint configuration and custom rules
- Jest presets for running unit tests and CSS-in-JS linting
- Optional client-only and server-only modes
- Ability to override Webpack configuration from `kyt.config.js`
## How it Works
`kyt` manages configuration for all aspects of development. It can be installed as a 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](/docs/commands.md) 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](/docs/kytConfig.md#modifywebpackconfig) for details, and our [recipes](/docs/Recipes.md) for examples.
## Setting up a kyt project
`kyt setup` is a utility for bootstrapping `kyt` projects and installing starter-kyts. It can be run to create a new project or integrate `kyt` with an existing project.
See the [kyt](/packages/kyt-core/README.md) documentation for more details.
## Command line
`kyt` includes a command line program with all the commands needed for development.
Running `kyt setup` includes these commands as scripts in your `package.json`:
```
yarn dev
```
Or you can run a command using `yarn kyt {command}`:
```
yarn kyt build
```
Here are the available commands:
- [`dev`](/docs/commands.md#dev) starts a development environment
- [`build`](/docs/commands.md#build) compiles server and client code for production use
- [`help`](/docs/commands.md#help) shows commands and their documentation
See our [CLI docs](/docs/commands.md) for further details.
## Conventions
`kyt` follows a few simple conventions.
All projects must have the following structure:
```
src/
client/
index.js
polyfills.js
server/
index.js
polyfills.js
```
Each `index.js` file acts as the build entry.
_(Note that `server/index.js` is not required if `hasServer` is `false` in [config](#configuration))._
_(Note that `client/index.js` is not required if `hasClient` is `false` in [config](#configuration))._
If you're setting up a new project see our full list of [conventions](/docs/conventions.md).
## Configuration
`kyt` allows you to specify options in a `kyt.config.js` file.
See the [kyt config docs](/docs/kytConfig.md) for instructions.
`kyt` uses Webpack to compile src code.
See our [recipes](/docs/Recipes.md) for extending configuration.
`kyt` respects Babel config files defined at the root of user projects, and provides [presets](/packages/babel-preset-kyt-react) to provide opinionated configurations. (If no Babel config file is defined in the user project, [`babel-preset-kyt-core`](https://www.npmjs.com/package/babel-preset-kyt-core) is used when compiling Webpack.)
## `starter-kyt`s
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 a boilerplate while minimizing the amount of new tools to learn and maintain.
The `kyt setup` command installs any preconfigured `starter-kyt` git repository, adding additional dependencies and building a source directory.
### How to build a `starter-kyt`
See additional info on [how to build a `starter-kyt`](/docs/Starterkyts.md).
## How to contribute to `kyt`
Want to help? See details [here](/CONTRIBUTING.md)
## Need Help?
1. Check our [FAQ](/docs/FAQ.md)
2. Submit an issue
3. Check out our [recipes](/docs/Recipes.md) for extending kyt
## Changelog
[Changelog](/CHANGELOG.md)