Skip to content
This repository has been archived by the owner on Aug 16, 2024. It is now read-only.

Commit

Permalink
chore: update readme (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
abhijeetnarvekar authored Jul 12, 2024
1 parent 572c6af commit 125a87a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 30 deletions.
37 changes: 7 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,50 +21,27 @@ npm install
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
In the project directory, you can run:

### `npm start`
### `npm run dev`

- Runs the app in the development mode.
- 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.
- You’ll also see any linter errors in the console.

### `npm run startHttps` on Linux
### `npm run test`

- Runs the app in the development mode.
- Open [https://localhost:3000](http://localhost:3000) to view it in the browser.
- The page will reload if you make edits.
- You’ll also see any linter errors in the console.
- Windows users should read: [Using HTTPS in Development](https://facebook.github.io/create-react-app/docs/using-https-in-development)
- Runs the tests

### `npm test`
### `npm run test:interactive`

- 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.
- Runs the tests in interactive mode

### `npm run 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.
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 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’ll 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’re ready for it.

## License

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"preview": "vite preview",
"test": "vitest run",
"test:interactive": "vitest",
"format:check": "prettier . --check",
"format": "prettier . --write"
},
Expand Down

0 comments on commit 125a87a

Please sign in to comment.