Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ _"This guide is a **living compendium** documenting the most important patterns
### Playground Project
[![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)

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.
> Playground was created in such a way that you can simply clone the repository locally and immediately play around on your own. It will help you to learn all the examples from this guide in a real project environment without the need to create some complicated environment setup by yourself.
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`.
> Playground project was created so that you can simply clone the repository locally and immediately play around with all the component patterns found in the guide. It will help you to learn all the examples from this guide in a real project environment without the need to create complicated environment setup by yourself.

## Contributing Guide
We are open for contributions. If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
Expand Down Expand Up @@ -1531,11 +1531,15 @@ We have our own recommended `tsconfig.json` that you can easily add to your proj

```tsx
{
"include": ["src", "typings"],
"include": [
"src",
"typings"
],
"exclude": [
"src/**/*.spec.*"
],
"extends": "./node_modules/react-redux-typescript-scripts/tsconfig.json",
"compilerOptions": {
// you can further customize options here
}
"compilerOptions": {}
}

```
Expand Down Expand Up @@ -1576,7 +1580,7 @@ We have our own recommended config that you can easily add to your project thank
```tsx
{
"extends": [
"react-redux-typescript-scripts/tslint-recommended.json",
"react-redux-typescript-scripts/tslint.json",
"react-redux-typescript-scripts/tslint-react.json"
],
"rules": {
Expand All @@ -1603,7 +1607,10 @@ We have our own recommended config that will automatically add a parser & plugin

```tsx
{
"extends": ["./node_modules/react-redux-typescript-scripts/eslint.js"],
"extends": [
"react-app",
"./node_modules/react-redux-typescript-scripts/eslint.js"
],
"rules": {
// you can further customize options here
}
Expand Down
8 changes: 4 additions & 4 deletions README_SOURCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ _"This guide is a **living compendium** documenting the most important patterns
### Playground Project
[![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)

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.
> Playground was created in such a way that you can simply clone the repository locally and immediately play around on your own. It will help you to learn all the examples from this guide in a real project environment without the need to create some complicated environment setup by yourself.
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`.
> Playground project was created so that you can simply clone the repository locally and immediately play around with all the component patterns found in the guide. It will help you to learn all the examples from this guide in a real project environment without the need to create complicated environment setup by yourself.

## Contributing Guide
We are open for contributions. If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
Expand Down Expand Up @@ -653,10 +653,10 @@ https://jestjs.io/
`npm i -D jest ts-jest @types/jest`

#### jest.config.json
::expander='playground/jest.config.json'::
::expander='configs/jest.config.json'::

#### jest.stubs.js
::expander='playground/jest.stubs.js'::
::expander='configs/jest.stubs.js'::

[⇧ back to top](#table-of-contents)

Expand Down
File renamed without changes.
File renamed without changes.
5 changes: 4 additions & 1 deletion playground/.eslintrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{
"extends": ["./node_modules/react-redux-typescript-scripts/eslint.js"],
"extends": [
"react-app",
"./node_modules/react-redux-typescript-scripts/eslint.js"
],
"rules": {
// you can further customize options here
}
Expand Down
23 changes: 23 additions & 0 deletions playground/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
Loading