dc/CONTRIBUTING.md

1.7 KiB

Data Controller

Contributing

Workflow guidelines

Wiki Page

Dependencies that requires licences

SheetJS Pro Version

To auth for SheetJS Pro version you need to use their private registry Add client/.npmrc file with following content:

@sheet:registry=https://pylon.sheetjs.com:54111/
//pylon.sheetjs.com:54111/:_authToken="TOKEN-GOES-HERE"

Handsontable

Licence should be inserted in the client/src/index.html file:

 <sasjs
    ...
    hotLicenceKey="LICENCE-GOES-HERE"
>
</sasjs>

Development

Update client/src/index.html so that it points to your SAS9, SASVIYA or SASJS backend.
Be aware that VIYA can be configured in such way that it would not work with cross origin frontend.
Follow this guide to disable CORS: https://sasjs.io/cors/ (NOTICE: Sometimes even this approach would fail to work, in such case it is imposible to set it up without reconfiguring the VIYA server)

Start dev server:

cd client

npm start

GUI Elements

For documentation on the Clarity Design System, including a list of components and example usage, see our website.

Code style

Run prettier fix:

npm run lint:fix

Generate docs

Typedoc is used for generating typescript documentation based on the code. That part is automated and beign done as a part of CI job.

Troubleshooting

Makedata service "could not create directory" error

The dcpath folder should have its permissions set so that the system account (SYSUSERID) can both read and write to it.

Example:

If dcpath is: '/tmp/dc'

Run:

chmod 777 /tmp/dc