Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ixoncloud/component-workspace

Mirror of our Component SDK workspace
https://github.com/ixoncloud/component-workspace

Last synced: 1 day ago
JSON representation

Mirror of our Component SDK workspace

Awesome Lists containing this project

README 

        
# IXON Custom Component Workspace



Welcome to your workspace for developing UI Components for the IXON Cloud. Note that creating UI Components requires you to be able to write JavaScript or Typescript code, and that you are familiar with the [Node.js](https://nodejs.org/) ecosystem. Experience with a web framework such as [Vue](https://vuejs.org/) or [Svelte](https://svelte.dev/) will come in handy as well.



This workspace will contain the UI Components that you've developed. You can check this workspace, with your UI Components, into your preferred versioning system. To do so, you can download this repository as a ZIP file, or use `degit`, as shown below. You don't need to fork this repository, as the actual Software Development Kit (SDK) will be installed into your `node_modules`, and you can install updates using `npm` as you normally do. You can access the SDK via the `npx cdk` scripts, as shown later in this guide.



To create a new project based on this template using degit:

```sh

npx degit ixoncloud/component-workspace my-project

cd my-project

```



Note that you will need to have [Node.js](https://nodejs.org/) and [Git](https://git-scm.com/) installed.



## Getting started



Install the dependencies...



```sh

npm install

```



Now you can generate your first component. Choose a name for the component. It must be lowercase and cannot contain spaces or special characters. Dashes (`-`) may be used to break up words. For example `'my-component'`.



```sh

npx cdk generate my-component

```



You will be prompted to select a template. Upon completion, you will find the source files for your newly created component in the `/components` directory.



To actually view and test your component, run the following command...



```sh

npx cdk simulate my-component

```



...this opens the simulator app in a browser and builds your component in watch-mode, which means that any changes to the component source files will trigger a rebuild and will auto-reload the simulator. It is also possible to test your component with platform data by configuring this in the simulator settings.



## Documentation



To check out docs and examples on how to develop a UI Component, visit [UI Component Development Docs](https://developer.ixon.cloud/docs/getting-started-ui-components).



The [@ixon-cdk/runner](https://www.npmjs.com/package/@ixon-cdk/runner) page has a complete overview of all commands that can be run in a component workspace project.



## Deployment to IXON Cloud



> The deployment requires a **company ID** and a **page-component-template ID**. Please refer to the [Deploying UI Components](https://developer.ixon.cloud/docs/deploying-ui-components) on our developer website how to obtain these (step 4. and 5.)



When your component is ready to be used in action, it can be deployed to the IXON Cloud. To do that, you must first log in with your IXON user account.



```sh

npx cdk login

```



Now that you're logged in, you can run the following command to deploy the component...



```sh

npx cdk deploy my-component

```



...You will be prompted for the company ID and page-component-template ID and whether you want to remember these settings to speed up the process for a next deployment.



If all goes well, the component gets uploaded to the platform and you'll receive a preview link. With this link you can test the component in production.



The final step is to publish the deployed component so that it becomes available to all company users...



```sh

npx cdk publish my-component

```



...You will be prompted to select a version out of a list of all unpublished versions up to the currently published version. Select the version you want to publish. If all goes well, it will now be available for all company users to use.