Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prefecthq/legacy-ui
The home of the Prefect 1 UI
https://github.com/prefecthq/legacy-ui
automation data-engineering hacktoberfest prefect prefect-server prefect-ui vue workflow
Last synced: 1 day ago
JSON representation
The home of the Prefect 1 UI
- Host: GitHub
- URL: https://github.com/prefecthq/legacy-ui
- Owner: PrefectHQ
- License: other
- Created: 2020-07-16T14:59:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T18:05:04.000Z (about 2 months ago)
- Last Synced: 2024-12-20T14:25:37.413Z (6 days ago)
- Topics: automation, data-engineering, hacktoberfest, prefect, prefect-server, prefect-ui, vue, workflow
- Language: Vue
- Homepage: https://cloud.prefect.io
- Size: 28.8 MB
- Stars: 179
- Watchers: 17
- Forks: 42
- Open Issues: 98
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Prefect UI
Note: This repo is for Prefect UI development. To run the Prefect UI as part of [Prefect Server](https://github.com/PrefectHQ/server/), install [Prefect](https://github.com/prefecthq/prefect) and run `prefect server start`.
### Installation
Prefect UI requires [Node.js](https://nodejs.org/) v14 and [npm](https://www.npmjs.com/) v6 to run.
You'll also need an API token from a professional Font Awesome account to build the project locally; this token should be placed in a git-ignored `.env` file (e.g. `.env.development.local`) as it's referenced by `.npmrc` for accessing the private FA npm registry.
Before starting the development server, you'll need to install project dependencies:
```sh
$ git clone https://github.com/PrefectHQ/ui.git
$ cd ui
$ npm install
```
Then, you can start the Prefect UI development server:
```sh
$ npm run serve
```
The Prefect UI should be available at [http://localhost:8080](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](https://webpack.js.org/) and [Vue CLI](https://cli.vuejs.org/) documentation.
### Testing
Prefect UI contains various unit tests for things like the Vuex store and Vue Router middleware; running theses tests locally requires [Jest](https://jestjs.io/). We recommend using a node package executor like [npx](https://www.npmjs.com/package/npx) for this dependency.
Running all unit tests:
```
$ npx jest
```
Running specific tests:
```
$ npx jest auth
# This will run tests found in middleware/authNavGuard.spec.js, store/auth.spec.js, and store/auth0.spec.js
```
### Development
We welcome contributions!
Prefect UI is built on [Vue.js](https://vuejs.org/), a modern front-end JavaScript framework. We generally depend on Google's Material Design guidelines, drawing on and extending the [Vuetify](https://vuetifyjs.com/en/) component library.
#### Building for production
For production builds:
```sh
$ npm run build
```
Compiled and minified code and assets are placed in the `dist/` folder; `dist/index.html` is the built application's entrypoint.
### The Prefect UI Docker image
This repo comes with a Dockerfile for building a UI image; it's generally not recommended to build this yourself but to instead use one of the versioned images found in the [PrefectHQ Dockerhub registry](https://hub.docker.com/r/prefecthq/ui).
#### Serving the built application
The Prefect UI requires a functional Prefect API to operate. For details on starting Prefect Server, visit the [docs](https://docs.prefect.io/api/latest/#ui-and-server).
#### Submitting a PR
PR Titles should include a prefix that sets out the purpose of the PR. Most PRs will begin with the prefix Bugfix or Feature. The title should describe the work and purpose of the PR clearly and succinctly and should be appropriate and safe for the Prefect community.
###### Example
Feature: Add create flow run method to automations
## License
Prefect UI is lovingly made by the team at [Prefect](https://www.prefect.io) and licensed under the [Prefect Community License](https://www.prefect.io/legal/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](https://github.com/PrefectHQ/ui/blob/master/LICENSE) or [contact us](https://www.prefect.io/pricing#contact).