# druid-kyt-starter

> This starter-kyt should serve as the base for Druid React apps. This was copied from [starter-kyt-universal](https://github.com/NYTimes/kyt/tree/master/packages/kyt-starter-universal).

Latest version **0.0.1-dev.2** (published 2017-10-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install druid-kyt-starter
pnpm add druid-kyt-starter
yarn add druid-kyt-starter
bun add druid-kyt-starter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-dev.2 |
| Published | 2017-10-19 |
| First published | 2017-10-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | jasum |
| Keywords | kyt, kyt-starter |

## Links

- npm: https://www.npmjs.com/package/druid-kyt-starter
- Repository: https://github.com/druidfi/druid-kyt-starter
- Homepage: https://github.com/druidfi/druid-kyt-starter/
- Issues: https://github.com/druidfi/druid-kyt-starter/issues
- npm.io page: https://npm.io/package/druid-kyt-starter

## Dependencies (8)

- [react](https://npm.io/package/react.md) 15.3.0
- [redux](https://npm.io/package/redux.md) ^3.7.2
- [express](https://npm.io/package/express.md) 4.15.3
- [react-dom](https://npm.io/package/react-dom.md) 15.3.0
- [compression](https://npm.io/package/compression.md) 1.6.2
- [react-redux](https://npm.io/package/react-redux.md) ^5.0.6
- [react-router](https://npm.io/package/react-router.md) 2.6.1
- [druid-kyt-default-configuration](https://npm.io/package/druid-kyt-default-configuration.md) ^0.0.1-dev.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.0.1-dev.2 (latest) — 2017-10-19
- 0.1.0-alpha.bba7ae1 (canary) — 2018-05-29
- 0.1.0-alpha.16a96ec — 2018-05-24
- 0.1.0-alpha.1ce189d — 2018-05-23
- 0.1.0-alpha.518c0c0 — 2018-05-23
- 0.1.0-alpha.4cf5078 — 2018-05-23
- 0.1.0-alpha.93d234d — 2018-05-21
- 0.1.0-alpha.fb5d4fb — 2018-05-17
- 0.1.0-alpha.bd60ac7 — 2018-05-16
- 0.1.0-alpha.9376dce — 2018-05-15
- 0.1.0-alpha.4d65a59 — 2018-05-14
- 0.1.0-alpha.5fa463b — 2018-05-14
- 0.1.0-alpha.3e5c7fd — 2018-05-14
- 0.1.0-alpha.82ebc8a — 2018-05-14
- 0.1.0-alpha.b43a770 — 2018-05-11
- … 47 more at https://npm.io/package/druid-kyt-starter/versions

## README

# Druid starter-kyt

This starter-kyt should serve as the base for Druid React apps. This was copied
from [starter-kyt-universal](https://github.com/NYTimes/kyt/tree/master/packages/kyt-starter-universal).

## Installation

First, you need kyt-cli:

    npm install -g kyt-cli

For information about installing software globally using NPM without sudo, see 
[this guide.](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md)

To install from this repo (which you should usually do), run

    kyt-cli setup -r git@github.com:druidfi/druid-kyt-starter.git

To install from a local clone of kyt-starter-druid, run

    kyt-cli setup -r /path/to/druid-kyt-starter/

kyt-cli may prompts to optionally create a project directory. If you already
have a project directory, it can initialize the starter kyt into the current
directory.

## Tools

The following are some of the tools included in this starter-kyt:

- [Express](https://expressjs.com/) - Server-side rendering
- [React](https://facebook.github.io/react/) - Component library
- [React Router](https://github.com/reactjs/react-router) - Server and client routing
- [Sass Modules](https://github.com/css-modules/css-modules) - CSS Modules with a Sass pre-processor for styles
- [Enzyme](https://github.com/airbnb/enzyme) - React component testing

## Notes on implementation

- As a performance optimization, React Router routes are loaded dynamically and chunked separately using the ES2015 `import()` directive. See more about  [Webpack 2 support](https://gist.github.com/sokra/27b24881210b56bbaff7#code-splitting-with-es6) and [dynamic routing](https://github.com/reactjs/react-router/blob/master/docs/guides/DynamicRouting.md).

## Directory structure (src/)

- **assets/**: E.g. logos can be put here. These will not be copied to webroot unless they are used.
- **client/**: Initialization code specific to the browser-side part.
- **components/**: Components that are shared between routes. For route-specific components, add them to routes/
- **public/**: These files will be copied to webroot directly.
- **routes/**: Routes and route-specific components.
- **server/**: Initialization and server code specific to the server-side part.
- **styles/**: SASS styles common to the whole application. Component-specific styles may be added in components.

---
_Source: https://npm.io/package/druid-kyt-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._