Basics and Setup
IMPORTANTThis SDK requires Node.JS and has been built and tested to work with
NodeJS v5 and above. On
unixyoperating systems that have
bash, you can use ** nvm (Node Version Manager) ** to install and quickly switch between multiple versions of Node. All provided run scripts are also only designed to work with
The SDK is currently distributed as a standalone
.zip file which contains basic app scaffolding for a traditional
Angular app, as well as build and deploy tools.
Unzip the provided
skedulo-customview-sdk.zip. The default directory with the two defined
Sample Views ( Patient and Telemedicine Forms ) would look like this.
IMPORTANTDo not modify any code within the
deployfolder. Changing those sources might break the forms in subtle ways that might be hard to find or reason about.
To get up and running quickly, the default
Angular app scaffold should work well enough. All code that needs to be written will be within the
All actions performed by the SDK are performed by calling the
./run.sh bash file. Try running it without any arguments.
The SDK depends on various
npm package dependencies to work properly. To install these dependencies just run:
> ./run.sh bootstrap
Internally, all that does is call
npm install from the
root as well as
public folders. Once the process completes, the SDK can be used to start building custom views.
public folder contains all dependencies used by the custom view itself. This includes,
When installing additional libraries ensure they are installed from the
Any build tools related packages (eg: additional babel packages, etc … ) must be installed in the root folder of the SDK. More on upgrading build tool capabilities are in the Build Tools section.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.