orion-design

Orion Design is the Vue and Typescript component library for Prefect 2.0 and [Prefect Cloud 2.0)[https://www.prefect.io/cloud/]. The components and utilities in this project are not meant to be used independently.

Install

npm i @prefecthq/orion-design --save --save-exact

Demo

https://orion-design.netlify.app/

To run locally for devlopment you can use npm run serve and go to the url outputted to the console.

Developing with Prefect Orion-UI

If you plan to develop against the Prefect Orion-UI you can install the orion-design package locally.

We recommend using the cli and running

npm i @prefecthq/orion-design@../../orion-design --save

in the Prefect Orion-UI project where ../../orion-design is the relative path from your Prefect orion-UI project’s directory to the orion-design project directory. You can also use an absolute path.

If you have done this succesfully, you should see your Prefect Orion-UI package.json and package-lock.json updated to show your local orion-design.

💡 Linking a package this way is the safest as it avoids having to do an npm i.

Then when linking orion-design to the prefect/orion-ui project you can do the following:

In orion-design (this repo):

npm run dev

In orion-ui:

npm run serve

Now any change you make in orion-design will trigger a reload in orion-ui.

Update

To update a package in a project you can either install latest or a specific version like

npm i @prefecthq/orion-design@latest --save --save-exact

OR

npm i @prefecthq/[email protected] --save --save-exact

Disclaimer

This project does not follow SEM versioning and major, minor, and patch updates mostly signify progress toward objectives. Breaking changes are introduced regularly without releasing a major version.