-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from DSDmark/DSDmark-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
54 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,72 @@ | ||
| # Create React App example with TypeScript | ||
| <div align="center"> | ||
|
|
||
| ## How to use | ||
| # SimpleWeb 💤 | ||
|
|
||
| Download the example [or clone the repo](https://github.com/mui/material-ui): | ||
|  | ||
|  | ||
|  | ||
|  | ||
| [](https://github.com/DSDmark/TodoList/actions/workflows/pages/pages-build-deployment) | ||
|
|
||
| <!-- #default-branch-switch --> | ||
| ## React App example with TypeScript and Material-ui 🚀 | ||
|
|
||
| ```sh | ||
| curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app-with-typescript | ||
| cd create-react-app-with-typescript | ||
| ``` | ||
| <div align="left"> | ||
|
|
||
| Install it and run: | ||
| ## Purpose 😑 | ||
|
|
||
| ```sh | ||
| npm install | ||
| npm start | ||
| ``` | ||
| > This example demonstrates how you can use [**Create React App**](https://github.com/facebookincubator/create-react-app) with [**TypeScript**](https://github.com/Microsoft/TypeScript). | ||
| It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. | ||
| If you prefer, you can [**use styled-components instead**](https://mui.com/material-ui/guides/interoperability/#styled-components). | ||
|
|
||
| or: | ||
| </div> | ||
|
|
||
| <!-- #default-branch-switch --> | ||
| <div align="left"> | ||
|
|
||
| [](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) | ||
| ### How to install 😒 | ||
|
|
||
| 1. Click on green **Clone or download** button and choose Download ZIP. | ||
| 2. Find the downloaded zipped file on your pc and extract it. | ||
| 3. Then install `nodejs` and `NPM` in your local system | ||
| 4. Open Root Directory and install all dependences by that commend `npm install`, | ||
| 5. Run commend. | ||
| > ```npm run start``` | ||
| Once you are done you can close 🔒 the application in your terminal to quit the application. | ||
|
|
||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| <div align="left"> | ||
|
|
||
| ### Here you can quick start with that repo 👼 | ||
|
|
||
| <!-- #default-branch-switch --> | ||
|
|
||
| [](https://stackblitz.com/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) | ||
|
|
||
| ## The idea behind the example | ||
| <!-- #default-branch-switch --> | ||
|
|
||
| [](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) | ||
|
|
||
| This example demonstrates how you can use [Create React App](https://github.com/facebookincubator/create-react-app) with [TypeScript](https://github.com/Microsoft/TypeScript). | ||
| It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. | ||
| If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). | ||
| </div> | ||
|
|
||
| ## What's next? | ||
| <div align="left"> | ||
|
|
||
| <!-- #default-branch-switch --> | ||
| ## Try Out TodoList Demo 🚀 | ||
|
|
||
| <a href="https://dsdmark.github.io/TodoList/" alt="TodoList Demo">TodoList Demo</a> | ||
|
|
||
| </div> | ||
|
|
||
| ### SimpleWeb | ||
|
|
||
|  | ||
|
|
||
| > If you have any issues with that Application feel free to let me know 🙃! | ||
| > If you are more interested, check out 🥺 the collection of [ **CLIsapplications**](https://github.com/DSDmark"DSDmark"). | ||
| --- | ||
|
|
||
| You now have a working example project. | ||
| You can head back to the documentation, continuing browsing it from the [templates](https://mui.com/material-ui/getting-started/templates/) section. | ||
| </div> |