https://github.com/visual-framework/vf-covid19-boilerplate
HTML VF boilerplate for Covid19 portals.
https://github.com/visual-framework/vf-covid19-boilerplate
Last synced: 19 days ago
JSON representation
HTML VF boilerplate for Covid19 portals.
- Host: GitHub
- URL: https://github.com/visual-framework/vf-covid19-boilerplate
- Owner: visual-framework
- Created: 2020-10-06T12:55:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T03:16:52.000Z (about 1 year ago)
- Last Synced: 2025-04-02T04:23:40.097Z (about 1 year ago)
- Language: HTML
- Homepage: https://visual-framework.github.io/vf-covid19-boilerplate/
- Size: 4.41 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VF Covid19 Build Boilerplate
Guidance, documentation and portable CSS+JS to build a site based off the [Covid19DataPortal.org](https://www.covid19dataportal.org/) look and UX (a [Visual Framework 2.0](https://visual-framework.github.io/vf-core/) site).
## CSS and JS
For basic styles and optional JS, include these files
```html
```
## HTML and how to
For HTML snippets and further and guidance view [visual-framework.github.io/vf-covid19-boilerplate](https://visual-framework.github.io/vf-covid19-boilerplate/)
---
## Developing this boilerplate
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`
- `yarn run build` build static assets
- `yarn run dev` renders and serves
1. Deploy in Github Pages `/build` folder
- `yarn deploy` build folder will get deployed to gh-pages branch
### 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.
- `gulp vf-component`
## Troubleshooting
Having problems? See https://visual-framework.github.io/vf-core/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.