You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Create React App](https://github.com/facebook/create-react-app) using
5
-
[react-md](https://react-md.dev) as the component library.
3
+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app) using [react-md](https://react-md.dev) as the component library.
6
4
7
5
## What's Included
8
6
9
-
This example will setup an example Create React App + ReactMD app that has the
10
-
following features:
7
+
This example will setup an example Create React App + ReactMD app that has the following features:
11
8
12
-
-[jsconfig.json](./jsconfig.json) to allow absolute imports instead of relative
13
-
imports from the `"src"` directory
14
-
-`import MyComponent from "components/MyComponent"` instead of
15
-
`import MyComponent from "../../components/MyComponent"`
16
-
-[\_variables.scss](./src/_variables.scss) to override the default `react-md`
17
-
theme and feature toggles
9
+
-[jsconfig.json](./jsconfig.json) to allow absolute imports instead of relative imports from the `"src"` directory
10
+
-`import MyComponent from "components/MyComponent"` instead of `import MyComponent from "../../components/MyComponent"`
11
+
-[\_variables.scss](./src/_variables.scss) to override the default `react-md` theme and feature toggles
18
12
- a reusable [Layout.jsx](./src/components/Layout/Layout.jsx) that:
19
13
- updates all the icons to use `SVGIcon`s instead of `FontIcon`s
20
14
- initializes the `Layout` component from `react-md` with navigation items
21
-
- uses [react-router-dom](https://www.npmjs.com/package/react-router-dom) as
22
-
the routing library
15
+
- uses [react-router-dom](https://www.npmjs.com/package/react-router-dom) as the routing library
23
16
24
17
## How to Use
25
18
26
-
Since this example is not a separate repo, this example will need to be manually
27
-
downloaded instead of using `create-react-app`:
19
+
Since this example is not a separate repo, this example will need to be manually downloaded instead of using `create-react-app`:
28
20
29
21
```bash
30
22
curl https://codeload.github.com/mlaursen/react-md/tar.gz/main | tar -xz --strip=2 react-md-main/examples/create-react-app
Launches the test runner in the interactive watch mode.\
71
+
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
79
72
80
73
### `yarn build`
81
74
82
-
Builds the app for production to the `build` folder.<br /> It correctly bundles
83
-
React in production mode and optimizes the build for the best performance.
75
+
Builds the app for production to the `build` folder.\
76
+
It correctly bundles React in production mode and optimizes the build for the best performance.
84
77
85
-
The build is minified and the filenames include the hashes.<br /> Your app is
86
-
ready to be deployed!
78
+
The build is minified and the filenames include the hashes.\
79
+
Your app is ready to be deployed!
87
80
88
-
See the section about
89
-
[deployment](https://facebook.github.io/create-react-app/docs/deployment) for
90
-
more information.
81
+
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
91
82
92
83
### `yarn eject`
93
84
94
85
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
95
86
96
-
If you aren’t satisfied with the build tool and configuration choices, you can
97
-
`eject` at any time. This command will remove the single build dependency from
98
-
your project.
87
+
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
99
88
100
-
Instead, it will copy all the configuration files and the transitive
101
-
dependencies (webpack, Babel, ESLint, etc) right into your project so you have
102
-
full control over them. All of the commands except `eject` will still work, but
103
-
they will point to the copied scripts so you can tweak them. At this point
104
-
you’re on your own.
89
+
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
105
90
106
-
You don’t have to ever use `eject`. The curated feature set is suitable for
107
-
small and middle deployments, and you shouldn’t feel obligated to use this
108
-
feature. However we understand that this tool wouldn’t be useful if you couldn’t
109
-
customize it when you are ready for it.
91
+
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
0 commit comments