mirror of
https://github.com/dcs-retribution/dcs-retribution.git
synced 2025-11-10 15:41:24 +00:00
77 lines
3.1 KiB
Markdown
77 lines
3.1 KiB
Markdown
# DCS Liberation Client
|
||
|
||
This is a React app for the front-end of DCS Liberation. It is a work in
|
||
progress that just barely implements the map. This is not useful for players
|
||
yet.
|
||
|
||
For development, set the following environment variables when launching DCS
|
||
Liberation (the Qt UI):
|
||
|
||
- `CORS_ALLOW_DEBUG_SERVER=true`
|
||
|
||
This will allow the front-end to make requests to the server, as long as the
|
||
front-end is running on http://localhost:3000.
|
||
|
||
Then, run `npm start` to start the development server. Launch the Qt UI with
|
||
`--new-map --dev` to connect the webview to the development server, or navigate
|
||
to http://localhost:3000 in your browser.
|
||
|
||
## Regenerating the API stubs
|
||
|
||
The backend uses FastAPI which exposes `/openapi.json`. This is consumed by
|
||
`@rtk-query/codegen-openapi` to automatically generate the API stubs in
|
||
`src/api/liberationApi.ts`.
|
||
|
||
If you make a change to the API surface the typescript API will need to be
|
||
regenerated. To do this, first launch Liberation (to start the backend) and run
|
||
|
||
```powershell
|
||
npm run regenerate-api
|
||
```
|
||
|
||
See https://redux-toolkit.js.org/rtk-query/usage/code-generation for more
|
||
information.
|
||
|
||
## Available Scripts
|
||
|
||
In the project directory, you can run:
|
||
|
||
### `npm start`
|
||
|
||
Runs the app in the development mode.<br />
|
||
Open [http://localhost:3000](http://localhost:3000) 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 />
|
||
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 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 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/).
|