github/OpenHands
1
1
Fork 0
mirror of https://github.com/All-Hands-AI/OpenHands.git synced 2026-01-08 22:38:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

update readme to include testing script and documentation (#1272)

Browse Source
This commit is contained in:
sp.wack
2024-04-22 18:54:28 +03:00
committed by GitHub
parent 0669b27522
commit f55f7be2e6
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
frontend/README.md
View File

@@ -12,6 +12,10 @@ Open [http://localhost:3001](http://localhost:3001) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `npm test`
This command runs the available test suites for the application. It launches the test runner in the interactive watch mode, allowing you to see the results of your tests in real time.
### `npm run build`
Builds the app for production to the `dist` folder.\
@@ -24,7 +28,7 @@ Your app is ready to be deployed!
You can set the environment variables in `frontend/.env` to configure the frontend. The following variables are available:
```javascript
VITE_BACKEND_HOST="127.0.0.1:3000" // The host of the backend
VITE_USE_TLS="false" // Whether to use TLS for the backend(includes HTTPS and WSS)
VITE_USE_TLS="false" // Whether to use TLS for the backend(includes HTTPS and WSS)
VITE_INSECURE_SKIP_VERIFY="false" // Whether to skip verifying the backend's certificate. Only takes effect if `VITE_USE_TLS` is true. Don't use this in production!
VITE_FRONTEND_PORT="3001" // The port of the frontend
```
@@ -37,3 +41,5 @@ The outside environment variables will override the ones in the `.env` file.
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/).
For more information on tests, you can refer to the official documentation of [Vitest](https://vitest.dev/) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/).