From 2b6b607933257b2e8deda04215ff4e27a0fb6175 Mon Sep 17 00:00:00 2001 From: Jonas DOREL <jonas.dorel@laposte.net> Date: Fri, 3 May 2019 14:14:41 +0200 Subject: [PATCH 1/2] Add instructions to build the module --- .../resources/Javascript/es6/README.mustache | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/modules/openapi-generator/src/main/resources/Javascript/es6/README.mustache b/modules/openapi-generator/src/main/resources/Javascript/es6/README.mustache index bb4fc276ea7..dd773d6c1bb 100644 --- a/modules/openapi-generator/src/main/resources/Javascript/es6/README.mustache +++ b/modules/openapi-generator/src/main/resources/Javascript/es6/README.mustache @@ -30,6 +30,38 @@ Then install it via: npm install {{{projectName}}} --save ``` +Finaly, you need to build the module: + +```shell +npm run build +``` + +##### Local development + +To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: + +```shell +npm install +``` + +Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: + +```shell +npm link +``` + +To use the link you just defined in your project, switch to the directory you want to use your {{{projectName}}} from, and run: + +```shell +npm link /path/to/<JAVASCRIPT_CLIENT_DIR> +``` + +Finaly, you need to build the module: + +```shell +npm run build +``` + #### git If the library is hosted at a git repository, e.g.https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}} -- GitLab From 814e5d9bf9a17ad1cb81c55fcc0c63b8fb3e68fc Mon Sep 17 00:00:00 2001 From: Jonas DOREL <> Date: Fri, 3 May 2019 18:00:36 +0200 Subject: [PATCH 2/2] Updated samples --- .../client/petstore/javascript-es6/README.md | 32 +++++++++++++++++++ .../petstore/javascript-promise-es6/README.md | 32 +++++++++++++++++++ 2 files changed, 64 insertions(+) diff --git a/samples/client/petstore/javascript-es6/README.md b/samples/client/petstore/javascript-es6/README.md index 3c17f8fdb8d..17aa96f29ea 100644 --- a/samples/client/petstore/javascript-es6/README.md +++ b/samples/client/petstore/javascript-es6/README.md @@ -22,6 +22,38 @@ Then install it via: npm install open_api_petstore --save ``` +Finaly, you need to build the module: + +```shell +npm run build +``` + +##### Local development + +To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: + +```shell +npm install +``` + +Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: + +```shell +npm link +``` + +To use the link you just defined in your project, switch to the directory you want to use your open_api_petstore from, and run: + +```shell +npm link /path/to/<JAVASCRIPT_CLIENT_DIR> +``` + +Finaly, you need to build the module: + +```shell +npm run build +``` + #### git If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID diff --git a/samples/client/petstore/javascript-promise-es6/README.md b/samples/client/petstore/javascript-promise-es6/README.md index 8ebec5fed87..6572c2f0c91 100644 --- a/samples/client/petstore/javascript-promise-es6/README.md +++ b/samples/client/petstore/javascript-promise-es6/README.md @@ -22,6 +22,38 @@ Then install it via: npm install open_api_petstore --save ``` +Finaly, you need to build the module: + +```shell +npm run build +``` + +##### Local development + +To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: + +```shell +npm install +``` + +Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: + +```shell +npm link +``` + +To use the link you just defined in your project, switch to the directory you want to use your open_api_petstore from, and run: + +```shell +npm link /path/to/<JAVASCRIPT_CLIENT_DIR> +``` + +Finaly, you need to build the module: + +```shell +npm run build +``` + #### git If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID -- GitLab