Skip to content

Commit e400b5c

Browse files
committed
[ui] update readme
1 parent 17352db commit e400b5c

File tree

1 file changed

+10
-24
lines changed

1 file changed

+10
-24
lines changed

quickwit/quickwit-ui/README.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Getting Started with Create React App
1+
# quickwit-ui
2+
23

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
44

55
## Prerequisites
66

7-
`node` and `npm` need to be installed on your system.
7+
`node` and `yarn` need to be installed on your system.
88
The project then relies on misc nodejs tools that can be installed locally by
9-
running `npm install`.
9+
running `yarn`.
1010

1111
## Available Scripts
1212

@@ -24,36 +24,22 @@ You will also see any lint errors in the console.
2424

2525
### `yarn test`
2626

27-
Launches the test runner in the interactive watch mode.\
28-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
27+
Launches the test runner.
2928

3029
### `yarn e2e-test`
3130

3231
Launches the e2e test runner with [cypress](https://www.cypress.io/). To make them work, you need to start a
3332
searcher beforehand with `cargo r run --service searcher --config config/quickwit.yaml`.
3433

34+
### `yarn format`
35+
36+
Re-writes files with the correct formatting if needed.\
37+
You might want to configure your IDE to do that [automatically](https://biomejs.dev/guides/editors/first-party-extensions/).
38+
3539
### `yarn build`
3640

3741
Builds the app for production to the `build` folder.\
3842
It correctly bundles React in production mode and optimizes the build for the best performance.
3943

4044
The build is minified and the filenames include the hashes.\
4145
Your app is ready to be deployed!
42-
43-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
44-
45-
### `yarn eject`
46-
47-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
48-
49-
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.
50-
51-
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.
52-
53-
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.
54-
55-
## Learn More
56-
57-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
58-
59-
To learn React, check out the [React documentation](https://reactjs.org/).

0 commit comments

Comments
 (0)