UOC Boilerplate
UOC Boilerplate is a starter template for the HTML and CSS Tools courses from the Master's Program in Multimedia Applications and the Master's Program in Web App and Website Development at the Universitat Oberta de Catalunya. It aims to provide a basic, modern frontend web development starter pack based on Parcel and including a Sass compiler, an ES6 transpiler, minifiers, an image optimizer, and development tools.
This is the 2.x version of UOC Boilerplate, available since the UOC 2018-2 semester.
Requirements
Node.js >= 10.15.x
Getting started
Clone this repository with git clone, or download a .zip file using the top right green button.
Using the Terminal, navigate to the project folder and run npm install.
Features
- Uses Parcel module bundler.
- NPM scripts for fast development and production build (see Commands below).
Stylesheets
- Sass/SCSS to CSS compilation.
- PostCSS features:
- Transpile modern CSS with
postcss-preset-env. - Automatically add CSS prefix to unsupported properties with
autoprefixer. - Automatically minify and optimize CSS code on production build with
postcss-clean.
- Transpile modern CSS with
Scripts
- Allow for modern JavaScript (ES201x/ES8/ES7/ES6…) which is automatically transpiled to ES5 and minifed in production builds, with Babel.
Images
- Image optimization with
parcel-plugin-imagemin, based onimagemin, on production builds.
Development
- Development server launch and live reloading on file changes.
- Friendly error reporting.
How to use this boilerplate
Only edit files located in the src/ folder. Always run the following commands during the development stage and for production builds. Please note that it is expected that all projects built with this boilerplate are compiled using npm run build before they are published.
Commands
| Command | Description |
|---|---|
npm run dev |
Runs a local web server for development and opens the browser to display it. Automatically compiles styles and scripts whenever a file in src/ is changed, and live reloads the browser. This is what must be run on the development stage. |
npm run build |
Compiles and minifies and optimizes the files in the assets folder. The generated compiled and optimized files are located in the dist/ folder. This is what must be run before publishing the project. The publishable files are the ones located in the dist/ folder. |
npm run clean |
Deletes the current /dist folder. |
npm run test |
Displays a success message if everything is working as expected. |
Need help? / Want to help out?
Feel free to create a new issue or drop me a line at jorditarrida@uoc.edu.
Are you using this Boilerplate for your projects or for educational purposes? I would love to hear about it!
