From b614bafd03cdd131aa38e46cfa52a7bd1e14f3c6 Mon Sep 17 00:00:00 2001 From: Krishna Acondy Date: Thu, 9 Jul 2020 08:14:50 +0100 Subject: [PATCH] chore(*): update references to master --- CONTRIBUTING.md | 12 +- README.md | 2 +- docs/index.html | 339 +++++++++++++++++++++++++++++++----------------- 3 files changed, 231 insertions(+), 122 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64c9592..398693c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Contributions to SASjs are very welcome! When making a PR, test cases should be included. To help in unit testing, be sure to run the following when making changes: +Contributions to SASjs are very welcome! When making a PR, test cases should be included. To help in unit testing, be sure to run the following when making changes: ``` # the following creates a tarball in the build folder of SASjs @@ -10,12 +10,13 @@ npm run-script package:lib npm install ../sasjs/build/ ``` -Tests are run using cypress. Before running tests, you need to define the following backend services: +Tests are run using cypress. Before running tests, you need to define the following backend services: # SAS 9 + ``` -filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/mc_all.sas?_=1"; +filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/main/mc_all.sas?_=1"; %inc mc; filename ft15f001 temp; parmcards4; @@ -37,8 +38,9 @@ parmcards4; ``` # Viya + ``` -filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/mc_all.sas"; +filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/main/mc_all.sas"; %inc mc; filename ft15f001 temp; @@ -77,4 +79,4 @@ parmcards4; %mv_createwebservice(path=/Public/app/common,name=sendArr) ``` -The above services will return anything you send. To run the tests simply launch `npm run cypress`. \ No newline at end of file +The above services will return anything you send. To run the tests simply launch `npm run cypress`. diff --git a/README.md b/README.md index cf6187e..839664c 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ For more information on building web apps with SAS, check out [sasjs.io](https:/ ## None of this makes sense. How do I build an app with it? -Ok ok. Deploy this [example.html](https://github.com/sasjs/adapter/blob/master/example.html) file to your web server, and update `servertype` to `SAS9` or `SASVIYA` depending on your backend. +Ok ok. Deploy this [example.html](https://github.com/sasjs/adapter/blob/main/example.html) file to your web server, and update `servertype` to `SAS9` or `SASVIYA` depending on your backend. The backend part can be deployed as follows: diff --git a/docs/index.html b/docs/index.html index 3056cd0..bf0b429 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,94 +1,179 @@ - + - - - - @sasjs/adapter - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
  • -
  • Public/Protected
  • -
  • All
  • -
-
- - -
-
- Menu -
-
-
-
-
-
-
    -
-
-
-
-
-
- -
-

@sasjs/adapter

-
-

- -

@sasjs/adapter

-
-

SASjs is a open-source framework for building Web Apps on SASĀ® platforms. You can use as much or as little of it as you like. This repository contains the JS adapter, the part that handles the to/from SAS communication on the client side. There are 3 ways to install it:

-

1 - npm install @sasjs/adapter - for use in a node project

-

2 - Download and use a copy of the latest JS file

-

3 - Reference directly from the CDN - in which case click here and select "SRI" to get the script tag with the integrity hash.

-

If you are short on time and just need to build an app quickly, then check out this video and the react-seed-app which provides some boilerplate.

-

For more information on building web apps with SAS, check out sasjs.io

- -

None of this makes sense. How do I build an app with it?

-
-

Ok ok. Deploy this example.html file to your web server, and update servertype to SAS9 or SASVIYA depending on your backend.

-

The backend part can be deployed as follows:

-
%let appLoc=/Public/app/readme;  /* Metadata or Viya Folder location as per SASjs config */
+  
+    
+    
+    @sasjs/adapter
+    
+    
+    
+  
+  
+    
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+
    +
    +
    +
    +
    +
    + +
    +

    @sasjs/adapter

    +
    +

    + +

    + +

    @sasjs/adapter

    +
    +

    + SASjs is a open-source framework for building Web Apps on SASĀ® + platforms. You can use as much or as little of it as you like. + This repository contains the JS adapter, the part that handles the + to/from SAS communication on the client side. There are 3 ways to + install it: +

    +

    + 1 - npm install @sasjs/adapter - for use in a node + project +

    +

    + 2 - + Download + and use a copy of the latest JS file +

    +

    + 3 - Reference directly from the CDN - in which case click + here + and select "SRI" to get the script tag with the + integrity hash. +

    +

    + If you are short on time and just need to build an app quickly, + then check out + this video and the + react-seed-app + which provides some boilerplate. +

    +

    + For more information on building web apps with SAS, check out + sasjs.io +

    + +

    None of this makes sense. How do I build an app with it?

    +
    +

    + Ok ok. Deploy this + example.html + file to your web server, and update servertype to + SAS9 or SASVIYA depending on your + backend. +

    +

    The backend part can be deployed as follows:

    +
    %let appLoc=/Public/app/readme;  /* Metadata or Viya Folder location as per SASjs config */
     /* compile macros (can also be downloaded & compiled seperately) */
    -filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/mc_all.sas";
    +filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/main/mc_all.sas";
     %inc mc;
     filename ft15f001 temp;
     parmcards4;
    @@ -102,30 +187,52 @@ parmcards4;
       %webout(OBJ,areas)
       %webout(CLOSE)
     ;;;;
    -%mp_createwebservice(path=&appLoc/common,name=getdata)

    You now have a simple web app with a backend service!

    - -

    More resources

    -
    -

    For more information specific to this adapter you can check out this user guide or the technical documentation.

    -

    For more information on building web apps in general, check out these resources or contact the author directly.

    -
    - -
    -
    - -
    -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - - \ No newline at end of file +%mp_createwebservice(path=&appLoc/common,name=getdata)
    +

    You now have a simple web app with a backend service!

    + +

    More resources

    +
    +

    + For more information specific to this adapter you can check out + this + user guide or + the + technical documentation. +

    +

    + For more information on building web apps in general, check out + these + resources or + contact the + author + directly. +

    +
    + +
    +
    + +
    +
    +
    +
    +
    +

    + Generated using + TypeDoc +

    +
    +
    + + + +