diff --git a/README.md b/README.md index 2c8a910..2673950 100644 --- a/README.md +++ b/README.md @@ -27,35 +27,44 @@ Runs the server in development mode with nodemon. ## Client -The client was bootstrapped with Create React App. +This is a [React App](https://react.dev/) bootstrapped with [vite](https://vitejs.dev/). -### Available Scripts - -In the client directory, you can run: - -#### `npm start` +## Getting Started -Runs the app in development mode.
-Open http://localhost:3000 to view it in the browser. +For Running the client app: -#### `npm test` +Steps to follows: -Launches the test runner in the interactive watch mode.
-See the section about running tests for more information. +install Dependencies: -#### `npm run build` +```bash +npm install +# or +yarn +``` -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. +### Available Scripts: -#### `npm run eject` +```bash +npm run dev +# or +yarn dev +``` -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** +Runs the app in development mode. Open http://localhost:5173 to view it in the browser. -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. +```bash +npm run build +# or +yarn build +``` -## Learn More +Builds the app for production to the `dist` folder. -You can learn more in the Create React App documentation. +```bash +npm run preview +# or +yarn preview +``` -To learn React, check out the React documentation. +Preview the production build locally. diff --git a/client/README.md b/client/README.md deleted file mode 100644 index f768e33..0000000 --- a/client/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# React + 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