From 21cfcdc65b049560a3087468317d79b3e17e92d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20D=C4=85browski?= Date: Wed, 14 Apr 2021 14:17:13 +0200 Subject: [PATCH] cleaner readme + bump typescript to 4.2.4 --- README.md | 41 +++++++++++++---------------------------- package.json | 2 +- yarn.lock | 2 +- 3 files changed, 15 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index b58e0af..7860529 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,31 @@ -# Getting Started with Create React App +# shopping-list + +> A shopping list using React and Firebase This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). -## Available Scripts +## Running + +Remember to have typescript installed. You can ensure that by running: + +### `yarn add typescript` In the project directory, you can run: ### `yarn start` -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +This runs the app in the development mode.\ +It should automatically open [http://localhost:3000](http://localhost:3000) to view it in the browser. -The page will reload if you make edits.\ +The page will self-reload if you make edits.\ You will also see any lint errors in the console. ### `yarn test` -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +Launches the test runner in the interactive watch mode. ### `yarn build` -Builds the app for production to the `build` folder.\ +Builds this React app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `yarn eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -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. - -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. - -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. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). diff --git a/package.json b/package.json index bbc1a59..22fa30a 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ "react-router-dom": "^5.2.0", "react-scripts": "4.0.3", "react-toastify": "^7.0.3", - "typescript": "^4.1.2", + "typescript": "^4.2.4", "uuid": "^8.3.2", "web-vitals": "^1.0.1" }, diff --git a/yarn.lock b/yarn.lock index 7317405..f24c523 100644 --- a/yarn.lock +++ b/yarn.lock @@ -11656,7 +11656,7 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= -typescript@^4.1.2: +typescript@^4.2.4: version "4.2.4" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.2.4.tgz#8610b59747de028fda898a8aef0e103f156d0961" integrity sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==