From 685d1bae452aece914f3d6d9dddf00ebd98a7b20 Mon Sep 17 00:00:00 2001 From: HaidynPeterson <123123243+HaidynPeterson@users.noreply.github.com> Date: Mon, 23 Mar 2026 08:06:38 -0500 Subject: [PATCH] Revise README for Vite and pnpm usage Updated README to reflect usage of Vite and pnpm. --- react-app/README.md | 65 +++++++++++---------------------------------- 1 file changed, 15 insertions(+), 50 deletions(-) diff --git a/react-app/README.md b/react-app/README.md index 429885c..60fc31d 100644 --- a/react-app/README.md +++ b/react-app/README.md @@ -1,70 +1,35 @@ -# Getting Started with Create React App +# Getting Started with the React App -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +This project uses **React with Vite** and **pnpm** for package management. ## Available Scripts In the react-app directory, you can run: -### `npm start` +### `pnpm start` -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +Runs the app in development mode.\ +Open [http://localhost:5173](http://localhost:5173) to view it in your browser. The page will reload when you make changes.\ You may also see any lint errors in the console. -### `npm test` +### `pnpm 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 (Vitest) in interactive watch mode.\ +Press `q` to quit the test runner. -### `npm run build` +### `pnpm build` -Builds the app for production to the `build` folder.\ +Builds the app for production to the `dist` 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.\ +The build is minified and the filenames include 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. +### `pnpm preview` -### `npm run eject` +Serves the production build locally for preview: -**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/). - -### Code Splitting - -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) - -### Analyzing the Bundle Size - -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) - -### Making a Progressive Web App - -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) - -### Advanced Configuration - -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) - -### Deployment - -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) - -### `npm run build` fails to minify - -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +```bash +pnpm preview