Skip to content
Snippets Groups Projects
Commit 95ddf20f authored by Johanna Szepanski's avatar Johanna Szepanski
Browse files

updated read me

parent ee93d7d5
No related branches found
No related tags found
2 merge requests!542Prepare 4.1.0,!532CE-2537: Use rtk query
Pipeline #196567 passed
...@@ -30,6 +30,15 @@ This project includes private dependencies from Artifactory, so additional confi ...@@ -30,6 +30,15 @@ This project includes private dependencies from Artifactory, so additional confi
Note, we lock dependency versions with _package-lock.json_; please install dependencies with `npm ci` (not npm install) to avoid overwriting the package-lock. Note, we lock dependency versions with _package-lock.json_; please install dependencies with `npm ci` (not npm install) to avoid overwriting the package-lock.
## Updating the API Files
This project uses `@rtk-query/codegen-openapi` to auto-generate the deploy api from its OpenAPI spec. To generate the spec:
1. Run `npm run generate-api` to update the api file; see `openapi-config.json` for path information.
1. Commit the changed file.
Note: default path to api spec is localhost. To generate a new spec BE must run locally. It is possible to change path to any other swagger environment, but it is preferred to use locally running backend.
### Proxying to Existing Backends ### Proxying to Existing Backends
For being able to run the backend, and frontend application on the same machine (locally) a proxy has been set in the project! For being able to run the backend, and frontend application on the same machine (locally) a proxy has been set in the project!
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment