From 099909e17feae8fa1b861ee127b089237e97fc93 Mon Sep 17 00:00:00 2001 From: nkumar2 Date: Tue, 9 Jul 2024 15:23:24 +0100 Subject: [PATCH] update README.md --- README.md | 40 ++++++---------------------------------- 1 file changed, 6 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 24c05bf..a78a0a8 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,6 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) - uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast - Refresh - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -} -``` - -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` - or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and - add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list +## Local Development & Testing +Run `npm run dev` for local development and testing. +## Production Deployment +Run `npm run build` for production deployment. +###### +The base path for application deployment can be updated in `vite.config.ts` \ No newline at end of file