From e01946f5328de28974026530214dfad220266509 Mon Sep 17 00:00:00 2001 From: Sanskar Sahu Date: Fri, 30 Dec 2022 12:44:24 +0630 Subject: [PATCH 1/2] Update README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0efedf4..2c5fc73 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,29 @@ -# Create React App example with TypeScript +
-## How to use +![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/DSDmark/TodoList) +![GitHub](https://img.shields.io/github/license/DSDmark/TodoList) +![GitHub language count](https://img.shields.io/github/languages/count/DSDmark/TodoList) +![GitHub last commit](https://img.shields.io/github/last-commit/DSDmark/TodoList) +[![pages-build-deployment](https://github.com/DSDmark/TodoList/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/DSDmark/TodoList/actions/workflows/pages/pages-build-deployment) + +## React App example with TypeScript and Material-ui 🚀 + +
+ +### 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. + +
+ +--- Download the example [or clone the repo](https://github.com/mui/material-ui): @@ -40,3 +63,5 @@ If you prefer, you can [use styled-components instead](https://mui.com/material- 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. + +
From f9d32a7ff7b441de92772d51a4a7fd444cbe1dbd Mon Sep 17 00:00:00 2001 From: Sanskar Sahu Date: Fri, 30 Dec 2022 13:06:24 +0630 Subject: [PATCH 2/2] Update README.md --- README.md | 55 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 30 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 2c5fc73..9e8071f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@
+# SimpleWeb 💤 + ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/DSDmark/TodoList) ![GitHub](https://img.shields.io/github/license/DSDmark/TodoList) ![GitHub language count](https://img.shields.io/github/languages/count/DSDmark/TodoList) @@ -10,7 +12,17 @@
-### How to install +## Purpose 😑 + +> 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). + +
+ +
+ +### 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. @@ -19,49 +31,42 @@ 5. Run commend. > ```npm run start``` -Once you are done you can close the application in your terminal to quit the application. +Once you are done you can close 🔒 the application in your terminal to quit the application.
--- -Download the example [or clone the repo](https://github.com/mui/material-ui): +
+ +### Here you can quick start with that repo 👼 -```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 -``` +[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) -Install it and run: + -```sh -npm install -npm start -``` +[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) -or: +
- +
-[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) +## Try Out TodoList Demo 🚀 - +TodoList Demo -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) +
-## The idea behind the example +### SimpleWeb -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). +![SimpleWeb perview](public/images/perview.gif "SimpleWeb") -## What's next? +> 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. +---