Skip to content

Commit 01bc1df

Browse files
committed
Updated readme
1 parent 0ff885d commit 01bc1df

File tree

2 files changed

+64
-28
lines changed

2 files changed

+64
-28
lines changed

README.md

+32-14
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,42 @@
1+
<div align="center">
2+
13
## React & Redux in TypeScript - Static Typing Guide
24

35
_"This guide is a **living compendium** documenting the most important patterns and recipes on how to use **React** (and its Ecosystem) in a **functional style** using **TypeScript**. It will help you make your code **completely type-safe** while focusing on **inferring the types from implementation** so there is less noise coming from excessive type annotations and it's easier to write and maintain correct types in the long run."_
46

57
[![Join the chat at https://gitter.im/react-redux-typescript-guide/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/react-redux-typescript-guide/Lobby)
6-
> #### _Found it useful? Want more updates?_ [**Show your support by giving a :star:**](https://github.com/piotrwitek/react-redux-typescript-guide/stargazers)
78

8-
:tada: _Now updated to be compatible with **TypeScript v3.1.6**_ :tada:
9+
:star: _Found it useful? Want more updates?_ [**Show your support by giving a :star:**](https://github.com/piotrwitek/react-redux-typescript-guide/stargazers)
10+
11+
:tada: _Now updated to support **TypeScript v3.1**_ :tada:
12+
13+
<a href="https://www.buymeacoffee.com/zh9guxbA5">
14+
<img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me a Coffee">
15+
</a>
16+
<a href="https://www.patreon.com/piotrekwitek">
17+
<img src="https://c5.patreon.com/external/logo/[email protected]" alt="Become a Patron" width="160">
18+
</a>
919

10-
:computer: _Reference implementation of Todo-App with `typesafe-actions`: https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox_ :computer:
20+
</div>
21+
22+
**Goals**
1123

12-
### Goals
1324
- Complete type safety (with [`--strict`](https://www.typescriptlang.org/docs/handbook/compiler-options.html) flag) without losing type information downstream through all the layers of our application (e.g. no type assertions or hacking with `any` type)
1425
- Make type annotations concise by eliminating redundancy in types using advanced TypeScript Language features like **Type Inference** and **Control flow analysis**
1526
- Reduce repetition and complexity of types with TypeScript focused [complementary libraries](#complementary-libraries)
1627

17-
### Complementary Libraries
18-
- [utility-types](https://github.com/piotrwitek/utility-types) - Collection of generic types for TypeScript, complementing built-in mapped types and aliases - think lodash for reusable types.
28+
**React, Redux, Typescript Ecosystem**
29+
1930
- [typesafe-actions](https://github.com/piotrwitek/typesafe-actions) - Typesafe utilities for "action-creators" in Redux / Flux Architecture
20-
- [react-redux-typescript-scripts](https://github.com/piotrwitek/react-redux-typescript-scripts) - dev-tools configuration files shared between projects based on this guide
31+
- [utility-types](https://github.com/piotrwitek/utility-types) - Collection of generic types for TypeScript, complementing built-in mapped types and aliases - think lodash for reusable types.
32+
- [react-redux-typescript-scripts](https://github.com/piotrwitek/react-redux-typescript-scripts) - dev-tools configuration files shared between projects based on this guide
33+
34+
**Codesandbox links**
35+
36+
- Reference Todo-App implementation using **React, Redux, Typescript Guide**: [Link](https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox)
37+
38+
**Playground Project**
2139

22-
### Playground Project
2340
[![Build Status](https://semaphoreci.com/api/v1/piotrekwitek/react-redux-typescript-guide/branches/master/shields_badge.svg)](https://semaphoreci.com/piotrekwitek/react-redux-typescript-guide)
2441

2542
You should check out Playground Project located in the `/playground` folder. It is a source of all the code examples found in the guide. They are all tested with the most recent version of TypeScript and 3rd party type-definitions (like `@types/react` or `@types/react-redux`) to ensure the examples are up-to-date and not broken with updated definitions. It's based on `create-react-app --typescript`.
@@ -28,19 +45,19 @@ You should check out Playground Project located in the `/playground` folder. It
2845
## Contributing Guide
2946
We are open for contributions. If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
3047

31-
## Sponsor
48+
## Funding
3249
This is an independent open-source project created by people investing their free time for the benefit of our community.
3350

3451
If you are using it please consider donating as this will guarantee the project will be updated and maintained in the long run.
3552

36-
Issues can be funded by anyone and the money will be transparently distributed to the contributors handling a particular issue.
53+
Issues can be funded by anyone interested in them being resolved. Reward will be transparently distributed to the contributor handling the task through the IssueHunt platform.
3754

3855
[![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/76996763)
3956

4057
---
4158

4259
## Table of Contents
43-
- [Introduction](#introduction)
60+
- [Installation](#installation)
4461
- [React - Type-Definitions Cheatsheet](#react---type-definitions-cheatsheet)
4562
- [React - Typing Patterns](#react---typing-patterns)
4663
- [Function Components - FC](#function-components---fc)
@@ -61,10 +78,11 @@ Issues can be funded by anyone and the money will be transparently distributed t
6178
- [Async Flow with `redux-observable`](#async-flow-with-redux-observable)
6279
- [Typing Epics](#typing-epics)
6380
- [Testing Epics](#testing-epics)
64-
- [Async Flow with `redux-thunk`](#async-flow-with-redux-thunk) 🌟 __NEW__
6581
- [Selectors with `reselect`](#selectors-with-reselect)
6682
- [Connect with `react-redux`](#connect-with-react-redux) 🌟 __NEW__
67-
- [Configuration & Dev Tools](#configuration-&-dev-tools)
83+
- [Typing connected component](#typing-connected-component)
84+
- [Typing connected component using `redux-thunk` action creators](#typing-connected-component-using-redux-thunk-action-creators) 🌟 __NEW__
85+
- [Configuration & Dev Tools](#configuration--dev-tools)
6886
- [Common Npm Scripts](#common-npm-scripts)
6987
- [TypeScript](#typescript)
7088
- [TSLib](#tslib)
@@ -82,7 +100,7 @@ Issues can be funded by anyone and the money will be transparently distributed t
82100

83101
---
84102

85-
# Introduction
103+
# Installation
86104

87105
### Type-Definitions for React & Redux
88106
```

README_SOURCE.md

+32-14
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,42 @@
1+
<div align="center">
2+
13
## React & Redux in TypeScript - Static Typing Guide
24

35
_"This guide is a **living compendium** documenting the most important patterns and recipes on how to use **React** (and its Ecosystem) in a **functional style** using **TypeScript**. It will help you make your code **completely type-safe** while focusing on **inferring the types from implementation** so there is less noise coming from excessive type annotations and it's easier to write and maintain correct types in the long run."_
46

57
[![Join the chat at https://gitter.im/react-redux-typescript-guide/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/react-redux-typescript-guide/Lobby)
6-
> #### _Found it useful? Want more updates?_ [**Show your support by giving a :star:**](https://github.com/piotrwitek/react-redux-typescript-guide/stargazers)
78

8-
:tada: _Now updated to be compatible with **TypeScript v3.1.6**_ :tada:
9+
:star: _Found it useful? Want more updates?_ [**Show your support by giving a :star:**](https://github.com/piotrwitek/react-redux-typescript-guide/stargazers)
10+
11+
:tada: _Now updated to support **TypeScript v3.1**_ :tada:
12+
13+
<a href="https://www.buymeacoffee.com/zh9guxbA5">
14+
<img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me a Coffee">
15+
</a>
16+
<a href="https://www.patreon.com/piotrekwitek">
17+
<img src="https://c5.patreon.com/external/logo/[email protected]" alt="Become a Patron" width="160">
18+
</a>
919

10-
:computer: _Reference implementation of Todo-App with `typesafe-actions`: https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox_ :computer:
20+
</div>
21+
22+
**Goals**
1123

12-
### Goals
1324
- Complete type safety (with [`--strict`](https://www.typescriptlang.org/docs/handbook/compiler-options.html) flag) without losing type information downstream through all the layers of our application (e.g. no type assertions or hacking with `any` type)
1425
- Make type annotations concise by eliminating redundancy in types using advanced TypeScript Language features like **Type Inference** and **Control flow analysis**
1526
- Reduce repetition and complexity of types with TypeScript focused [complementary libraries](#complementary-libraries)
1627

17-
### Complementary Libraries
18-
- [utility-types](https://github.com/piotrwitek/utility-types) - Collection of generic types for TypeScript, complementing built-in mapped types and aliases - think lodash for reusable types.
28+
**React, Redux, Typescript Ecosystem**
29+
1930
- [typesafe-actions](https://github.com/piotrwitek/typesafe-actions) - Typesafe utilities for "action-creators" in Redux / Flux Architecture
20-
- [react-redux-typescript-scripts](https://github.com/piotrwitek/react-redux-typescript-scripts) - dev-tools configuration files shared between projects based on this guide
31+
- [utility-types](https://github.com/piotrwitek/utility-types) - Collection of generic types for TypeScript, complementing built-in mapped types and aliases - think lodash for reusable types.
32+
- [react-redux-typescript-scripts](https://github.com/piotrwitek/react-redux-typescript-scripts) - dev-tools configuration files shared between projects based on this guide
33+
34+
**Codesandbox links**
35+
36+
- Reference Todo-App implementation using **React, Redux, Typescript Guide**: [Link](https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox)
37+
38+
**Playground Project**
2139

22-
### Playground Project
2340
[![Build Status](https://semaphoreci.com/api/v1/piotrekwitek/react-redux-typescript-guide/branches/master/shields_badge.svg)](https://semaphoreci.com/piotrekwitek/react-redux-typescript-guide)
2441

2542
You should check out Playground Project located in the `/playground` folder. It is a source of all the code examples found in the guide. They are all tested with the most recent version of TypeScript and 3rd party type-definitions (like `@types/react` or `@types/react-redux`) to ensure the examples are up-to-date and not broken with updated definitions. It's based on `create-react-app --typescript`.
@@ -28,19 +45,19 @@ You should check out Playground Project located in the `/playground` folder. It
2845
## Contributing Guide
2946
We are open for contributions. If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
3047

31-
## Sponsor
48+
## Funding
3249
This is an independent open-source project created by people investing their free time for the benefit of our community.
3350

3451
If you are using it please consider donating as this will guarantee the project will be updated and maintained in the long run.
3552

36-
Issues can be funded by anyone and the money will be transparently distributed to the contributors handling a particular issue.
53+
Issues can be funded by anyone interested in them being resolved. Reward will be transparently distributed to the contributor handling the task through the IssueHunt platform.
3754

3855
[![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/76996763)
3956

4057
---
4158

4259
## Table of Contents
43-
- [Introduction](#introduction)
60+
- [Installation](#installation)
4461
- [React - Type-Definitions Cheatsheet](#react---type-definitions-cheatsheet)
4562
- [React - Typing Patterns](#react---typing-patterns)
4663
- [Function Components - FC](#function-components---fc)
@@ -61,10 +78,11 @@ Issues can be funded by anyone and the money will be transparently distributed t
6178
- [Async Flow with `redux-observable`](#async-flow-with-redux-observable)
6279
- [Typing Epics](#typing-epics)
6380
- [Testing Epics](#testing-epics)
64-
- [Async Flow with `redux-thunk`](#async-flow-with-redux-thunk) 🌟 __NEW__
6581
- [Selectors with `reselect`](#selectors-with-reselect)
6682
- [Connect with `react-redux`](#connect-with-react-redux) 🌟 __NEW__
67-
- [Configuration & Dev Tools](#configuration-&-dev-tools)
83+
- [Typing connected component](#typing-connected-component)
84+
- [Typing connected component using `redux-thunk` action creators](#typing-connected-component-using-redux-thunk-action-creators) 🌟 __NEW__
85+
- [Configuration & Dev Tools](#configuration--dev-tools)
6886
- [Common Npm Scripts](#common-npm-scripts)
6987
- [TypeScript](#typescript)
7088
- [TSLib](#tslib)
@@ -82,7 +100,7 @@ Issues can be funded by anyone and the money will be transparently distributed t
82100

83101
---
84102

85-
# Introduction
103+
# Installation
86104

87105
### Type-Definitions for React & Redux
88106
```

0 commit comments

Comments
 (0)