Skip to content

Commit

Permalink
Merge pull request #71 from ESTOS/fix-sample
Browse files Browse the repository at this point in the history
Fix vulnerabilities and formatted readme.md inclusive some line how t…
  • Loading branch information
JanFellner authored Sep 11, 2024
2 parents a2cab08 + 038e490 commit fa2a185
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 33 deletions.
14 changes: 7 additions & 7 deletions samples/ts-microservice/client/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 15 additions & 13 deletions samples/ts-microservice/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,23 @@ Depending on the methog beeing called the server just answers or will create del
# server
The server is node based

* Running the sample
** Have at least node 18 and VSCode installed.
** Server:
*** Navigate into the server folder and call npm ci to install the dependencies
*** Adopt .env.sample and save it as .env
**** The listen port of the server is required on the client side
## Running the sample
* Have at least node 18 and VSCode installed.
* Server:
* Navigate into the server folder and call `npm ci` to install the dependencies
* Adopt .env.sample and save it as .env
* The listen port of the server is required on the client side
* Call `npm run build` which compiles the TypeScript into JavaScript
* Call `npm run start` to start the example server

** Client:
*** Navigate into the client folder and call npm ci to install the dependencies
*** Adopt .env.sample and save it as .env
*** Open the microservicetemplate_client.code-workspace in VSCode
*** Call npm start in the console of VSCode
*** In Run and Debug select the appropriate client and http:// or https:// depending on your configuration
* Client:
* Navigate into the client folder and call `npm ci` to install the dependencies
* Adopt .env.sample and save it as .env
* Open the microservicetemplate_client.code-workspace in VSCode
* Call `npm start` in the console of VSCode
* In Run and Debug select the appropriate client and http:// or https:// depending on your configuration

# OpenApi
This is an example usage of https://www.npmjs.com/package/@estos/esnacc-openapi-sdk?activeTab=readme

Either you start it with `npm run start` that uses the local npm package or you use `npm run serve` that just hosts the schema and index.html and gets the sdk from unpkg
Either you start it with `npm run start` that uses the local npm package or you use `npm run serve` that just hosts the schema and index.html and gets the sdk from unpkg
26 changes: 13 additions & 13 deletions samples/ts-microservice/server/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fa2a185

Please sign in to comment.