Website

The website of Malvid has been developed using Malvid itself. The project structure is based on a HTML5 Boilerplate called Skeleton-Components.

Contents

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

Requirements

The website dependents on …

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

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

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

This project 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 malvid/website .

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" malvid/website

Troubleshooting

• Install the latest version of Node.js and yarn
• Delete node_modules and reinstall all dependencies
• Check if all dependencies are up-to-date
• Try to compile the site using the included Dockerfile