electerious/Skeleton-Components

A front-end Malvid template build upon Rosid.

Skeleton

Jump-start your front-end development. Skeleton is a HTML5 Boilerplate build upon Rosid.

Contents

• Features
• Requirements
• Setup
• How to use
  • Develop
  • Compile
  • UI
• Docker
• Troubleshooting

Features

• Skeleton is a base for all your everyday web-projects. Jump-start your work and develop without starting from zero. Everything you need one fork away.
• This project is powered by Rosid, a web server with just-in-time pre-processing. JS (with Babel, UglifyJS), SASS (with cssnano, Autoprefixer) and Nunjucks can be used right out of the box.
• Skeleton is just the beginning. Fork it and extend it to your own needs. The predefined structure gives you flexibility and can be modified with ease.

Requirements

Skeleton dependents on …

• Node.js (v8.5.0 or newer)
• yarn

Make sure to install and update all dependencies before you fork and setup Skeleton.

Setup

Install all required dependencies with yarn before you start developing.

yarn install

How to use

Develop

Start developing using the following command. You browser will open, wait for code-changes and live-reload instantly when you update your files. JS, SASS and Nunjucks will be compiled on-the-fly.

yarn start

Compile

Ready for prime time? Export all files, compiled and prepared for your audience. Simple upload the final dist/ folder to your server and relax. Take a seat and enjoy a delicious burger from your favorite restaurant.

yarn run compile

UI

Skeleton includes Malvid to help you build and document web components. Start the development server and open /index.html in your browser. The path to the UI can be changed in rosidfile.js.

Docker

The included Dockerfile lets you build an image which compiles your site. In this case only Docker needs to be installed on the system. No other dependencies are required.

Build

Build an image from the Dockerfile. This has to be done each time you have modified the project. The new source will be copied into the image.

docker build -t electerious/skeleton .

Compile

Start a container to compile your site. The container will exit automatically when all tasks have been finished. The mounted volume will contain all compiled files.

docker run --rm -tv "$(pwd)/dist:/dist" electerious/skeleton

Troubleshooting

• Install the latest version of Node.js and yarn
• Delete node_modules and reinstall all dependencies
• Check if the project depends on the newest version of Rosid
• Try to compile the site using the included Dockerfile