Skip to content

Commit 95e6361

Browse files
committed
updated docs
1 parent bd539ed commit 95e6361

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
11
## _React v15.3.1 / Redux v3.5.2 / TypeScript v2.0_ - starter-kit
2-
#### __Hot-Reload / React-Router / Seamless-Immutable / Fetch API / JSPM (SystemJS & Rollup)__
2+
#### __React-Router / Seamless-Immutable / Fetch API / JSPM (SystemJS with Hot-Reload & Rollup)__
33

4-
> ##### Futuristic, production-ready development environment for building _Component-Driven, Flux Single Page Applications with React, Redux and TypeScript_ - utilizing power of Static Type Checking, ES2016, Async/Await, ES Modules, Linting, Reliable Hot-Reload, Git-Hooks, in browser (on-the-fly) transpilation, bundling with Rollup - powered by JSPM (SystemJS & Rollup).
4+
> ##### Futuristic, production-ready development environment for building _Component-Driven, Flux Single Page Applications with React, Redux and TypeScript_ - utilizing power of Static Type Checking, ES2016, Async/Await, ES6 Modules, Linting, Git-Hooks, fast in browser (on-the-fly) transpilation, bundling with tree-shaking - powered by JSPM (SystemJS with Hot-Reload & Rollup).
55
66
### Demo: http://piotrwitek.github.io/react-redux-typescript-starter-kit/
77

88
### Features
99
- CLEAN - minimal dependencies, no clutter!
1010
- NO-SETUP - working out-of-the-box (more in Usage section below...)
11-
- RELIABLE HOT-RELOAD - dev server with hot-reload using [jspm-hmr](https://www.npmjs.com/package/jspm-hmr) - highly reliable and scalable with increasing modules count (more in Notes section below...)
12-
- GREAT-TYPESCRIPT-EXPERIENCE - in browser (on-the-fly) loading / no transpilation step / no bundling step
13-
- TYPESAFE-API-CALLS - type checking (request and response object) in calls to REST API, no more problems with service contracts
14-
- REACT-BEST-PRACTICES - no mixins / no ref strings / no method binding - instead ES Class Fields / no function creation in render methods / render lists in dedicated components / don't use array index as key / ES6 style PureRenderMixin with PureComponent
11+
- RELIABLE-HOT-RELOAD - dev server with hot-reload using [jspm-hmr](https://www.npmjs.com/package/jspm-hmr) - highly reliable and scalable with increasing modules count (more in Notes section below...)
12+
- TYPESCRIPT-WORKFLOW - in browser (on-the-fly) loading / no transpilation step / no bundling step
13+
- BEST-INTELLISENSE - statically typed entire JavaScript and DOM API with autocompletion and docs right in your editor - no more silly typos and runtime exceptions
14+
- TYPESAFE-API-CALLS - type checking the contracts of REST Service API calls - forget checking for API docs again
15+
- REACT-BEST-PRACTICES - no mixins / no ref strings / no method binding - instead ES Class Fields / no function/objects creation in render methods / render lists in dedicated components / don't use array index as key / ES6 style PureRenderMixin with PureComponent
1516
- REACT-ROUTER - included `react-router-redux` to store your routing in state for Time-Travel capabilities
1617
- IMMUTABLE-STORE - using `seamless-immutable` for simplicity and backwards-compatibility with vanilla JS (no hassle with `toJS()`, `get()`, `getIn()` in your containers and components)
17-
- COMPLETE-WORKFLOW - npm scripts for bundling & deploy, github-hooks, linter, test runner etc.
18+
- PRODUCTION-READY - npm scripts for bundling & deploy, github-hooks, linter, test runner etc.
1819
- EASY-TESTING - complete testing solution with Tape (blue-tape), Enzyme, JSDOM - functional approach makes it easy to test, you can even write and run test entirely in TypeScript - no transpilation step!
19-
- CSS MODULES - simplest and reliable approach for local CSS styles using csjs - https://github.com/rtsao/csjs#faq
20-
- BEM and ITCSS - using BEM with Inverted Triangle conventions to give meaning and context to CSS classes
20+
- CSS-MODULES - simplest and reliable approach for local CSS styles using csjs - https://github.com/rtsao/csjs#faq
21+
- BEM & ITCSS - using BEM with Inverted Triangle conventions to give meaning and context to CSS classes
2122

2223
---
2324

24-
### Code Examples
25+
### Code Examples
2526
- React and Redux with TypeScript - production ready code samples
2627
- Flux Standard Actions for Redux - https://github.com/acdlite/redux-actions
2728
- Redux Reducer Modules - https://github.com/erikras/ducks-modular-redux

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-redux-typescript-starter-kit",
33
"version": "0.8.0",
4-
"description": "Futuristic, production-ready development environment for building Component-Driven, Flux Single Page Applications with React, Redux and TypeScript - powered by JSPM / SystemJS / Rollup.",
4+
"description": "Futuristic, production-ready development environment for building Component-Driven, Flux Single Page Applications with React, Redux and TypeScript - powered by JSPM (SystemJS with Hot-Reload & Rollup).",
55
"main": "server.js",
66
"author": "Piotr Witek <piotrek.witek@gmail.com> (http://piotrwitek.github.io/)",
77
"homepage": "https://github.com/piotrwitek/react-redux-typescript-starter-kit",

0 commit comments

Comments
 (0)