majikman111/prefect-ui-proxy repository overview

⁠ ⁠

⁠

⁠Prefect UI

Note: This repo is for Prefect UI development. To run the Prefect UI as part of Prefect Server⁠, install Prefect⁠ and run prefect server start.

⁠Installation

Prefect UI requires Node.js⁠ v10+ and npm⁠ v6+ to run.

Before starting the Prefect UI development server, you'll need to install project dependencies:

$ git clone https://github.com/PrefectHQ/ui.git
$ cd ui
$ npm install

Then, you can start the Prefect UI development server:

$ npm run serve

The Prefect UI should be available at http://localhost:8080⁠; changes to the code in the src/ directory will result in a hot reload of the application. For more information on hot-reloading or the development server, take a look at the Webpack⁠ and Vue CLI⁠ documentation.

⁠Testing

Coming soon...

⁠Development

We welcome contributions!

Prefect UI is built on Vue.js⁠, a modern front-end JavaScript framework. We generally depend on Google's Material Design guidelines, drawing on and extending the Vuetify⁠ component library.

⁠Building for production

For production builds:

$ npm run build

Compiled and minified code and assets are placed in the dist/ folder; dist/index.html is the built application's entrypoint.

⁠Building a Prefect UI Docker image

Coming soon...

⁠Serving the built application

Coming soon...

⁠License

Prefect UI is lovingly made by the team at Prefect⁠ and licensed under the Prefect Community License⁠. For information on how you can use, extend, and depend on Prefect UI to automate your data, take a look at our license⁠ or contact us⁠.