Skip to content

Commit 89a5ae6

Browse files
committed
saner project readme without versions
1 parent ef3ba46 commit 89a5ae6

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

packages/react-scripts/template/README.md

+46-46
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,66 @@
11
# aaa-react-scripts-ts
22

3-
Customized react template project generator using the current default settings [at all about apps](https://allaboutapps.at).
3+
Customized react template project generator for [at all about apps](https://allaboutapps.at) using the current default settings.
44

55
## Typical Dependencies at all about apps
66

7-
Continue with installing some of those typical libraries depending on your project needs (some where already installed automatically and are thus flagged with ``).
7+
Anything not flagged as **[optional]** is typically included in a newly generated app.
88

99
### General
10-
* `` [`react`](https://npmjs.org/package/react) `~15.4.2` + [`@types/react`](https://npmjs.org/package/@types/react) `~15.0.6`
11-
* `` [`react-dom`](https://npmjs.org/package/react-dom) `~15.4.2` + [`@types/react-dom`](https://npmjs.org/package/@types/react-dom) `~0.14.22`
10+
* [`react`](https://npmjs.org/package/react) + [`@types/react`](https://npmjs.org/package/@types/react)
11+
* [`react-dom`](https://npmjs.org/package/react-dom) + [`@types/react-dom`](https://npmjs.org/package/@types/react-dom)
1212

1313
### UI
14-
* `` [`material-ui`](https://npmjs.org/package/material-ui) `~0.16.7` + `` [`@types/material-ui`](https://npmjs.org/package/@types/material-ui) `~0.16.49`
15-
* `` [`react-tap-event-plugin`](https://npmjs.org/package/react-tap-event-plugin) `~2.0.1` + `` [`@types/react-tap-event-plugin`](https://npmjs.org/package/@types/react-tap-event-plugin) `~0.0.30`
14+
* [`material-ui`](https://npmjs.org/package/material-ui) + [`@types/material-ui`](https://npmjs.org/package/@types/material-ui)
15+
* [`react-tap-event-plugin`](https://npmjs.org/package/react-tap-event-plugin) + [`@types/react-tap-event-plugin`](https://npmjs.org/package/@types/react-tap-event-plugin)
1616
* to make `onTouchTap` click-handler available
17-
* Form validation
18-
* [`formsy-react`](https://npmjs.org/package/formsy-react) `~0.18.1`
19-
* [`formsy-material-ui`](https://npmjs.org/package/formsy-material-ui) `~0.5.4`
20-
21-
### State management
22-
* [`mobx`](https://npmjs.org/package/mobx) `~3.1.0`
23-
* [`mobx-react`](https://npmjs.org/package/mobx-react) `~4.1.0`
24-
* Storage
25-
* [`mobx-persist`](https://npmjs.org/package/mobx-persist) `~0.2.1`
26-
* [`localforage`](https://npmjs.org/package/localforage) `~1.4.3` + [`@types/localforage`](https://npmjs.org/package/@types/localforage) `~0.0.33`
27-
* Use as AsyncStorage Adapter for mobx-persist
28-
29-
### Routing
30-
* [`react-router`](https://npmjs.org/package/react-router) `~3.0.2` + [`@types/react-router`](https://npmjs.org/package/@types/react-router) `~3.0.0`
31-
* Attention `v4` will change its API completely (in a saner way)
32-
* Depending on the project your can use [`junctions`](https://github.com/jamesknelson/junctions) as an alternative or switch to fully serverside rendering through [`next.js`](https://github.com/zeit/next.js/).
33-
34-
### GraphQL
35-
* [`apollo-client`](https://npmjs.org/package/apollo-client) `~0.8.2`
36-
* [`graphql-tag`](https://npmjs.org/package/graphql-tag) `~1.2.4` (already used as devDependency in the webpack build chain, install you own version too if needed!)
37-
* [`react-apollo`](https://npmjs.org/package/react-apollo) `~0.9.0`
38-
* DevDependencies
39-
* `@playlyfe/gql` `~2.2.1` + [GraphQL for VSCode](https://marketplace.visualstudio.com/items?itemName=kumar-harsh.graphql-for-vscode)
40-
* `apollo-codegen` `~0.10.6`
41-
* `` `jest-transform-graphql` `~1.0.0` (already installed in test chain)
42-
43-
### Styling and Animations
44-
* `` [`styled-components`](https://npmjs.org/package/styled-components) `~1.4.3`
45-
* [`react-swipeable-views`](https://npmjs.org/package/react-swipeable-views) `~0.10.4` + [`@types/react-swipeable-views`](https://npmjs.org/package/@types/react-swipeable-views) `~0.0.27`
46-
* `` [`react-addons-css-transition-group`](https://npmjs.org/package/react-addons-css-transition-group) `~15.4.2` + `` [`@types/react-addons-css-transition-group`](https://npmjs.org/package/@types/react-addons-css-transition-group) `~15.0.1`
47-
* `` [`react-animations`](https://npmjs.org/package/react-animations) `~0.1.0`
48-
* [`react-router-transition`](https://npmjs.org/package/react-router-transition) `~0.0.6`
4917

5018
### i18n
51-
* `` [`react-intl`](https://npmjs.org/package/react-intl) `~2.2.3`
52-
* A custom `@types/react-intl` is supplied in generated projects that introduces the generic IDS for certain methods to check used i18n keys during compile time
53-
* `` [`intl`](https://npmjs.org/package/intl) `~1.2.5`
19+
* [`react-intl`](https://npmjs.org/package/react-intl)
20+
* A custom `@types/react-intl` is supplied in generated projects that introduces the generic IDS to check used i18n keys during compile time
21+
* [`intl`](https://npmjs.org/package/intl)
5422
* Polyfill, use `require.ensure`
5523

24+
### Styling and Animations
25+
* [`styled-components`](https://npmjs.org/package/styled-components)
26+
* **[optional]** [`react-swipeable-views`](https://npmjs.org/package/react-swipeable-views) + [`@types/react-swipeable-views`](https://npmjs.org/package/@types/react-swipeable-views)
27+
* [`react-addons-css-transition-group`](https://npmjs.org/package/react-addons-css-transition-group) + [`@types/react-addons-css-transition-group`](https://npmjs.org/package/@types/react-addons-css-transition-group)
28+
* [`react-animations`](https://npmjs.org/package/react-animations)
29+
* **[optional]** [`react-router-transition`](https://npmjs.org/package/react-router-transition)
30+
5631
### Util
57-
* `` [`@types/node`](https://npmjs.org/package/@types/node) `~7.0.4`
58-
* [`lodash`](https://npmjs.org/package/lodash) `~4.17.4` + [`@types/lodash`](https://npmjs.org/package/@types/lodash) `~4.14.52`
59-
* [`hoist-non-react-statics`](https://npmjs.org/package/hoist-non-react-statics) `~1.2.0`
32+
* [`@types/node`](https://npmjs.org/package/@types/node)
33+
* **[optional]** [`lodash`](https://npmjs.org/package/lodash) + [`@types/lodash`](https://npmjs.org/package/@types/lodash). Typically our favourite utility-belt (alá std-lib)
34+
* [`hoist-non-react-statics`](https://npmjs.org/package/hoist-non-react-statics)
6035
* If you write your own Higher Order Components / experimental component decorators
61-
* `` [`@types/webpack-env`](https://npmjs.org/package/@types/webpack-env) `~1.13.0`
36+
* [`@types/webpack-env`](https://npmjs.org/package/@types/webpack-env)
6237
* To make `require.ensure` overloading available (used for code splitting)
63-
* `` [`@types/jest`](https://npmjs.org/package/@types/jest) `~16.0.6
38+
* [`@types/jest`](https://npmjs.org/package/@types/jest)
39+
40+
### **[optional]** Form validation
41+
* [`formsy-react`](https://npmjs.org/package/formsy-react)
42+
* [`formsy-material-ui`](https://npmjs.org/package/formsy-material-ui)
43+
44+
### **[optional]** State management
45+
* [`mobx`](https://npmjs.org/package/mobx)
46+
* [`mobx-react`](https://npmjs.org/package/mobx-react)
47+
* Storage
48+
* [`mobx-persist`](https://npmjs.org/package/mobx-persist)
49+
* [`localforage`](https://npmjs.org/package/localforage) + [`@types/localforage`](https://npmjs.org/package/@types/localforage)
50+
* Use as AsyncStorage Adapter for mobx-persist
51+
52+
### **[optional]** Routing
53+
* [`react-router`](https://npmjs.org/package/react-router) + [`@types/react-router`](https://npmjs.org/package/@types/react-router)
54+
* Depending on the project your can also use [`junctions`](https://github.com/jamesknelson/junctions) as an alternative or switch to fully serverside rendering through [`next.js`](https://github.com/zeit/next.js/).
55+
56+
### **[optional]** GraphQL
57+
* [`apollo-client`](https://npmjs.org/package/apollo-client)
58+
* [`graphql-tag`](https://npmjs.org/package/graphql-tag) (already used as devDependency in the webpack build chain, install you own version too if needed!)
59+
* [`react-apollo`](https://npmjs.org/package/react-apollo)
60+
* DevDependencies
61+
* `@playlyfe/gql` + [GraphQL for VSCode](https://marketplace.visualstudio.com/items?itemName=kumar-harsh.graphql-for-vscode)
62+
* `apollo-codegen`
63+
* `jest-transform-graphql` (already installed in test chain)
6464

6565
## Original Readme:
6666

0 commit comments

Comments
 (0)