https://github.com/visual-framework/vf-build-boilerplate
Convert VF components to static CSS and JS to pair with your existing application or site.
https://github.com/visual-framework/vf-build-boilerplate
Last synced: 11 months ago
JSON representation
Convert VF components to static CSS and JS to pair with your existing application or site.
- Host: GitHub
- URL: https://github.com/visual-framework/vf-build-boilerplate
- Owner: visual-framework
- Created: 2019-10-04T17:58:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-27T03:30:11.000Z (11 months ago)
- Last Synced: 2025-04-27T04:26:10.286Z (11 months ago)
- Language: JavaScript
- Size: 4.08 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VF Build Boilerplate
A minimal implementation to build VF 2.0 components into static CSS and JS to pair with your existing application or site.
> Looking for other ways to use Visual Framework 2.0 components?
> [See the guide](https://visual-framework.github.io/vf-welcome/building/)
## Creating a new project powered by vf-build-boilerplate
There are two methods you can use:
1. Use the interactive yarn template [RECOMMENDED]
- If you don't have npm, [install it](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- The [`create-vf-project`](https://github.com/visual-framework/create-vf-project) allows you to interactively create a new site by typing
`yarn create @visual-framework/vf-project your-new-site-name vf-build-boilerplate`
- Follow the prompts
1. The GitHub template
- Click the "[Use this template](https://help.github.com/en/articles/creating-a-repository-from-a-template)" method; quick url: https://github.com/visual-framework/vf-build-boilerplate/generate
- Follow the prompts and then clone the new project to your local machine
## Configuring the build
- In `package.json` update `vfConfig`
- If you need any ad hoc CSS and JS, add it in `./src/components/vf-local-overrides`
Otherwise configure gulp like any other project.
## Building assets, developing
1. You'll need to [install npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
1. If you don't have `yarn`, install it
- https://yarnpkg.com/lang/en/docs/install/
1. Install all the things
- `yarn install`
1. Generate the site in `/build`
- `gulp dev` renders and serves
- `gulp build` build static assets
### Adding Visual Framework components
To add a component, use the command line or install it manually.
- by package: `yarn add @visual-framework/vf-logo`
- updating components: `yarn upgrade-interactive --latest` (alias: `yarn run update-components`)
- Manual installation for customisation
- Download a pattern
- Copy it to `./src/components/vf-component-name`
- Create your own local component
- You can add a custom VF-compatible component to `./src/components` and use it in your site.
- `yarn add vf-component-generator --dev`
- `gulp vf-component`
## Troubleshooting
Having problems? See https://visual-framework.github.io/vf-welcome/troubleshooting/
## Footnotes
- Why `yarn` and not `npm`?
For the particular structure of the Visual Framework components, Yarn is considerably
faster at installing and does so more efficiently (about half the total file size). You'll
also be able to use `yarn upgrade-interactive --latest`, which makes it easier to update
VF components.