https://github.com/visual-framework/vf-react
A React boilerplate for VF 2.0
https://github.com/visual-framework/vf-react
Last synced: 12 months ago
JSON representation
A React boilerplate for VF 2.0
- Host: GitHub
- URL: https://github.com/visual-framework/vf-react
- Owner: visual-framework
- Created: 2019-09-06T09:58:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T03:36:53.000Z (about 1 year ago)
- Last Synced: 2025-04-04T04:26:44.451Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://visual-framework.github.io/vf-react/
- Size: 5.78 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vf-react
A React boilerplate for VF 2.0 projects.
Demo: https://visual-framework.github.io/vf-react/
Notes:
- If you add a Visual Framework component, be sure to include it at `src/vf-components/vf-componenet-rollup/index.scss`
- Add custom CSS to `src/vf-components/vf-local-overrides/vf-local-overrides.scss`
- Bootstrapped with [Create React App](https://github.com/facebook/create-react-app), that brings certain advantages and limitations. If you want to escape those, read up on "[eject](https://create-react-app.dev/docs/available-scripts#npm-run-eject)"
Watchout for:
- Use `yarn` and not `npm`
- This is still in early development
- The building of VF component assets (CSS, JS, images, etc.) from `.vf-components` into `./build/vf-generated-assets` does not seem to be working after [#25](https://github.com/visual-framework/vf-react/pull/25)
- Gulp may eventually removed from this project
- We're still coming up with an approach on how to handle the use of VF JS inside React (probably we'll import the VF JS modules directly)
## Available scripts
In the project directory, you can run:
### `gulp build-vf-assets`
Build the assets, CSS and JS for VF components.
### `gulp dev`
- Build the assets, CSS and JS for VF components and watch for changes
- Run React in development mode
### `gulp build`
- Build the assets, CSS and JS for VF components
- Run React in build mode (yarn start)
### `yarn test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.