From dd5b9543a1c22126eef54b2b5da50abae8a971e0 Mon Sep 17 00:00:00 2001 From: AndreGCX Date: Wed, 6 Oct 2021 12:09:45 +0100 Subject: [PATCH 1/3] Update readme --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++--- logo.png | Bin 0 -> 1368 bytes 2 files changed, 63 insertions(+), 3 deletions(-) create mode 100644 logo.png diff --git a/README.md b/README.md index ce8432f7..5ed281f7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,64 @@ -# AST Javascript Wrapper + +
+

+ + Logo + -Release documentation: -https://checkmarx.atlassian.net/wiki/spaces/AID/pages/6030655776/ast-cli-javascript-wrapper +

AST-CLI-JAVASCRIPT-WRAPPER

+ + +
+ Table of Contents +
    +
  1. + About The Project +
    2. +
  2. + Getting Started + +
    3. +
  3. Contact
    4. +
+
+ + + + +## About The Project + +The Javascript-Wrapper is part of the AST-CLI project that provides a shared infrastructure across the AST projects. +It contains technology neutral repository interfaces as well as a metadata model for persisting Javascript classes. + + +## Getting Started + +### Prerequisites + +To be able to build the code you should have: +* Node + ``` + You can download and install Node using this link: https://nodejs.org/en/download/ +``` + + +### Setting Up + + +In your terminal, run: +``` +- npm install +``` + + +## Contact + +Checkmarx - AST Integrations Team + +Project Link: [https://github.com/CheckmarxDev/ast-cli-javascript-wrapper](https://github.com/CheckmarxDev/ast-cli-javascript-wrapper) + + +© 2021 Checkmarx Ltd. All Rights Reserved. diff --git a/logo.png b/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f6de6beb0ef16f38aff6b5d40873dc32d1591e69 GIT binary patch literal 1368 zcmV-e1*iInP)~(N6=th(-DfpJEcE7}D3v%NWt~htU8fVO2nRAnPC9$3`l!NiV(*cZlfq>>sW~Jy^z? zfLX-Np-V5c0e9(Nj<97jBCQDc=u~c`DRwap2n^x`t*0x|1uS4J;OYyxEfRDvT@2$C zOEyF_67Z{IxflqXV;Z4I{5wE1T8f4+pauhi8V)e6&{{n|!Zr-ij=;5J*``N#G38KE zd0-tOF-)R8bV?9On|LlmZM4ahwar9xj-*d-gV*IQPQMuS_0~=fr?|= z1jQR8u%~iaBJ{^jqc+BQ*ia~$nHEsBK-6LkpvlY%_~=AFp$KfNT$?2Nk*ZZhT;|JX zvJr+jpz6P<^netDr(f&O#4{CvtG~+ixjCE*Rq>b_d4&edjDVc7f@kxBMs9G49T+f? z6n^Jik0Yhd&PaNR{iBCbgo1F&&V}fvP;c(vA<*j^nyZyZAm8x(JkIHcJM`;1_{M3m zr~Q*NilRdEHM`)Pvd|Ha);`ndV=5PrZusoBIhsXP6)`h%!|b_qn&4p&W2tY!+OIT) zX|$4enGm^%_<1?HF*>eNmgYnWJ%&MQM?9w52vof3OvF?9UK5=~dZ9?kFy=JY^fufSzyfXeDa)E$S zf+&w68@ZISoBdWan|4-K1yg(n+i-JCDO;tHJFzO9uS;971f}eL@CMDYQ}#L&ZDS58 zQh3t|W?ZFgyNZ;(&cypbs>~g25jkaPJuRBD>om=^cl5w(h>EY0C#2k8Ii15Y&q-L>aZ z`*ea+qa0cBEpn4@k0?r65}|O)a+H10r4I0fO$un>lz{!EXjmJebyGTXbaKjO(@a59 zfsMPaxmQ!$fVz%zn@V{b(x!#J^EMcdaQ9+FChdvJ9tnxO01ceomCFU|!Et8$WI_da z0SzftKzU}TS#=pb0fm|!HUF<(WwQx8*(%pjmH!JGXcZA56ird;uc%2yOjVTHgv#gC zB*bHCi8?CRritDGBP{{rlzKAN&6ckkkzmL4 zltKVQ{`g_=`zPOK?|P7!BJyp3?_r3&H(Z}cDN=Ol85?jJ_7rL9(XqvD!un?> Date: Wed, 6 Oct 2021 12:22:22 +0100 Subject: [PATCH 2/3] minor update --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 5ed281f7..aba3e1f4 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,18 @@ It contains technology neutral repository interfaces as well as a metadata model ## Getting Started +#### Package configuration + +Add the following dependency: + + + "dependencies": { + "@checkmarxdev/ast-cli-javascript-wrapper": "{version}" + } + + + + ### Prerequisites To be able to build the code you should have: From 97bea9e1cad3d59e44d32414839c63c2ca177465 Mon Sep 17 00:00:00 2001 From: AndreGCX Date: Wed, 6 Oct 2021 12:44:43 +0100 Subject: [PATCH 3/3] environment variable setup --- README.md | 42 +++++++++++++++++++++++++++++------------- 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index aba3e1f4..7f77fc62 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,6 @@ - - ## About The Project @@ -40,31 +38,49 @@ It contains technology neutral repository interfaces as well as a metadata model Add the following dependency: - - "dependencies": { - "@checkmarxdev/ast-cli-javascript-wrapper": "{version}" - } - - - +``` +"dependencies": { + "@checkmarxdev/ast-cli-javascript-wrapper": "{version}" +} +``` ### Prerequisites To be able to build the code you should have: * Node - ``` - You can download and install Node using this link: https://nodejs.org/en/download/ -``` ### Setting Up - In your terminal, run: ``` - npm install ``` +To run integrations tests, you need to set up environment variables: + +- In Linux systems run in terminal: +``` +export CX_CLIENT_ID="{value}" +export CX_CLIENT_SECRET="{value}" +export CX_APIKEY="{value}" +export CX_BASE_URI="{value}" +export CX_BASE_AUTH_URI="{value}" +export CX_TENANT="{value}" +export PATH_TO_EXECUTABLE="{value}" +``` + +- In Windows systems run in powershell: +``` +setx CX_CLIENT_ID {value} +setx CX_CLIENT_SECRET {value} +setx CX_APIKEY {value} +setx CX_BASE_URI {value} +setx CX_BASE_AUTH_URI {value} +setx CX_TENANT {value} +setx PATH_TO_EXECUTABLE {value} +``` + ## Contact