rauricoste-web-builder
v8.0.0
Published
This project provides tools to build a web project as a SPA or with classic static files.
Downloads
116
Readme
Summary
This project provides tools to build a web project as a SPA or with classic static files.
It is a bundle of famous tools such as :
Installation
npm install --save-dev rauricoste-web-builderUsage
node ./node_modules/rauricoste-web-builder/bin/reactWatch.js <my config>.json: builds your project and then starts a static server using browser-sync. Your files are watched and your browser reloads when they change.node ./node_modules/rauricoste-web-builder/bin/reactBuild.js <my config>.json: builds your project ready for production. The difference with the previous build is that files are minified and source maps are not generated.node ./node_modules/rauricoste-web-builder/bin/reactBuildDebug.js <my config>.json: builds your project for development, in the same way thatreactWatch.jsdoes it. You can also use this mode in production for debugging purpose (source maps are generated) although files will be bigger since they are not minified.
Configuration
As seen in previous section "Usage", you have to provide a config file. This file is designed to be simple as possible. The drawback is that this tool cannot be customized much.
Exemple :
{
// destination folder where the files will be built
"dist": "dist",
// list of libs you want to compile using browserify and babel
// they will be exposed in window.libs
"libs": ["rauricoste-file"],
// list of modules you want to build
"modules": {
// module name. You can put whatever you want here
"spa-app": {
// root directory of your module. All paths in this module
// will start from this root.
"src": "src/main",
// indicates that you want to use brwserify for this module.
"browserify": {
// entry file for browserify. The full path will
// then be :
// "src/main/core/App.js"
"entry": "core/App.js",
// output file for browserify (in the dist directory)
// full path will be : "dist/js/App.js"
"output": "js/App.js"
},
// if true, this module's files will be watched for changes
// and the browser will reload if a change is detected.
"watch": true
},
"home": {
"src": "src/main",
// indicates that you want all files with these extensions
// to be copied into the "dist" directory
"assets": ["eot", "svg", "ttf", "woff", "woff2", "mp4", "jpg", "png", "gif"],
"watch": true
},
"htmlTemplates": {
"src": "src/templates",
// indicates that you want to use the template system
"template": {
// entry files for the template system
"roots": [
"faq-candidat.html",
"faq-recruteur.html"
],
// output directory (relative to the "dist" directory)
"output": "."
},
"watch": true
},
"libs": {
"src": "src/lib",
// indicates that you want your ".js" files to be copied to
// the "dist" directory
"assets": ["js"],
"watch": false
}
}
}Template system
It is a simple template system that lets you build files using the ES6 feature String interpolation
A template(template file name, properties) function is provided
to be able to build components.
Exemple :
home.html
<html>
${template("head.html", { title: "This is my title", cssFilename: "home.css"
})}
</html>
<body></body>head.html
<head>
<title>${props.title}</title>
<link rel="stylesheet" type="text/css" href="css/${props.cssFilename}" />
</head>When configurating the system with home.html as a root template file,
it will generate the following file :
<html>
<head>
<title>This is my title</title>
<link rel="stylesheet" type="text/css" href="css/home.css" />
</head>
<body></body>
</html>