Skip to content

Commit 9b08f75

Browse files
authored
Update README.md
1 parent 523af22 commit 9b08f75

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
1-
# React / TypeScript / JSPM starter-kit
2-
> Modern & Minimalistic boilerplate for building modular apps with React - utilizing power of TypeScript, ES2016, async/await, ES Modules powered by JSPM/SystemJS.
1+
# React / TypeScript / JSPM / Hot-Reload starter-kit
2+
> Modern & Minimalistic boilerplate for building modular apps with React - utilizing power of TypeScript, ES2016, Hot-Reload, async/await, ES Modules & in-browser transpiling powered by JSPM/SystemJS.
33
44
> Main goal of this boilerplate project is to keep up-to-date with the new releases of React / TypeScript / JSPM, and to follow changes in the best practices as they might change with a new updates.
55
66
> TypeScript 2.0 on horizon - until the official release I will use beta branch for planned update.
77
88
## Features
9-
- clean with bare minimum dep to make React & TypeScript & dev server with hot-reload running - the rest is up to you
10-
- easy start - just npm install && npm start to run dev server and you're ready to start coding
11-
- simple and clean dev server with hot-module-reload for JSPM - [jspm-hmr](https://www.npmjs.com/package/jspm-hmr)
12-
- added static dev-bundle (with external deps) setup for quick full-page reload, this is most important as this will make JSPM very fast
9+
##### Core
10+
- clean with minimal dependencies to make React & TypeScript work
11+
- dead-simple dev server with hot-module-reload and in-browser transpiling - [jspm-hmr](https://www.npmjs.com/package/jspm-hmr)
12+
- easy start - npm install && npm start to start coding
13+
- helpful npm scripts to automate development workflow tasks
14+
- github hooks using husky
15+
- nice css loader while waiting for React to "kick in"
16+
##### TypeScript
1317
- Typescript custom ambient definitions for external libraries - best-practices & example
14-
- React with TypeScript - best-practices & example code & typings
15-
- (async/await best practices with example code in progress)
16-
- typescript nightly builds (@next) for coolest new features, tsconfig setup for ES2016 support
18+
- tsconfig setup for ES2016 support
19+
- using npm @types instead of typings
20+
- unit testing examples in TypeScript with Tape
21+
- async/await - example code (WIP)
22+
- using regenerator instead of Babel to transpile generators/async/await to ES5 (soon with TypeScript 2.1 release it will be not needed anymore)
23+
##### React
24+
- React usage with TypeScript and ES6 - example code
25+
- Redux Store with TypeScript - example code (TODO)
26+
- Unit-testing behaviour and rendering of React Components (TODO)
27+
##### JSPM
1728
- JSPM 0.17.X - most recent beta version up stay up-to-date with best-practices
29+
- added static dev-bundle (external deps) setup for quick full-page reload (this will make JSPM lighting fast)
1830
- bundling for production in `~/dist/` folder - open production build on dev server `http://localhost/dist/`
1931
- importing and bundling CSS dependencies using JSPM `plugin-css`
20-
- usefull npm run scripts to automate many development workflow tasks
21-
- github hooks using husky (in progress)
22-
- nice css loader while waiting for React to "kick in"
23-
- using regenerator to transpile generators/async/await to ES5 (soon with TypeScript 2.0 release it will be not needed)
2432

2533
---
2634

0 commit comments

Comments
 (0)