https://github.com/flowfuse/forge-ui-components

Set of FlowForge-themed VueJS components that can be used in any FlowForge web applications.
https://github.com/flowfuse/forge-ui-components

Last synced: 1 day ago
JSON representation

Set of FlowForge-themed VueJS components that can be used in any FlowForge web applications.

• Host: GitHub
• URL: https://github.com/flowfuse/forge-ui-components
• Owner: FlowFuse
• License: apache-2.0
• Created: 2022-03-01T16:50:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-02T12:42:37.000Z (2 months ago)
• Last Synced: 2024-11-11T20:35:21.404Z (3 days ago)
• Language: Vue
• Size: 6.22 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FlowForge UI Components

Detailed documentation on each of the available components (including examples) can be found here: https://flowfuse.github.io/forge-ui-components/

## How to use

In order to include these Vue components into an existing VueJs project, include the following in your `main.js` file:

```javascript

// Import FlowForge UI Vue Components

import ForgeUIComponents from '@flowforge/forge-ui-components'

// Import FlowForge UI Component Styling

import '@flowforge/forge-ui-components/dist/forge-ui-components.css'

createApp()

    .use(ForgeUIComponents)

    .mount(...)

```

## Contributing

### Build Library

```bash

npm install

npm run build

```

In order to build the project, ready for publishing and use, run the `npm run build` command. This will output three files: into `/dist`:

```

/dist/forge-ui-components.css

/dist/forge-ui-components.js

/dist/forge-ui-components.mjs

```

### Build Documentation

```bash

npm run build-docs

```

The GitHub pages documentation is built into `/dist/docs` (defined in `vue.config.js`). It is configured as a subtree of the GitHub repo on the `gh-pages` branch.

### Running Documentation

```bash

npm run serve

```

The documentation should then become available at `http://localhost:8080` (or the next available port)

## References

Project structure inspired by: https://blog.logrocket.com/building-vue-3-component-library/