docs: update README for Vite migration
Replace Create React App scripts with Vite equivalents. Removes npm start, npm test, and npm run eject. Adds npm run dev, npm run preview, npm run lint, npm run format, and npm run format:check. Updates links to Vite and React docs.
This commit is contained in:
@@ -1,45 +1,45 @@
|
||||
# CelLoc-3D
|
||||
|
||||
React project for celloc3d.brain.riken.jp
|
||||
|
||||
## Available Scripts
|
||||
|
||||
In the project directory, you can run:
|
||||
|
||||
### `npm start`
|
||||
### `npm run dev`
|
||||
|
||||
Runs the app in the development mode.<br>
|
||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||||
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
|
||||
|
||||
The page will reload if you make edits.<br>
|
||||
You will also see any lint errors in the console.
|
||||
|
||||
### `npm test`
|
||||
|
||||
Launches the test runner in the interactive watch mode.<br>
|
||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
||||
|
||||
### `npm run build`
|
||||
|
||||
Builds the app for production to the `build` folder.<br>
|
||||
Builds the app for production to the `dist` folder.<br>
|
||||
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.<br>
|
||||
Your app is ready to be deployed!
|
||||
|
||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
||||
### `npm run preview`
|
||||
|
||||
### `npm run eject`
|
||||
Locally preview the production build.
|
||||
|
||||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
||||
### `npm run lint`
|
||||
|
||||
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.
|
||||
Run ESLint to check for code quality issues.
|
||||
|
||||
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.
|
||||
### `npm run format`
|
||||
|
||||
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.
|
||||
Format code using Biome.
|
||||
|
||||
### `npm run format:check`
|
||||
|
||||
Check code formatting without making changes.
|
||||
|
||||
## Learn More
|
||||
|
||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
||||
You can learn more in the [Vite documentation](https://vite.dev/guide/).
|
||||
|
||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
||||
To learn React, check out the [React documentation](https://react.dev/).
|
||||
|
||||
Reference in New Issue
Block a user