Quick Start

Below is a brief guide to help you quickly get started and start using Tailbreeze.

What’s included

The Tailbreeze source code includes HTML, javascript, font assets, images and SVG files along with source SCSS and documentation. More specifically, it includes the following and more:

documentation/
app/
  ├── production/
  └── development/
      ├── _namer
      ├── src/
      │    ├── assets/
      │    │     ├── fonts/
      │    │     ├── img/
      │    │     ├── js/
      │    │     └── scss/
      │    ├── pages/
      │    │     ├── index.html
      │    │     ├── accordion.html
      │    │     ├── badges.html
      │    │     └── ...
      │    └── partials/
      │          ├── _head.html
      │          ├── _header.html
      │          ├── _footer.html
      │          └── ...
      ├── tailwind.config.js
      ├── package.json
      ├── package-lock.json
      ├── .gitignore
      ├── .parcelrc
      ├── .postcssrc
      ├── .posthtmlrc
      └── .prettierrc

Installation

Make sure to install the latest version of Node.js and NPM before you start. You can download Node.js from https://nodejs.org/en/download/.

  1. Go to the project directory 
    cd tailbreeze
  2. Install dependencies 
    npm install
  3. Builds and serve the template 
    npm start

Now you can preview the template using the localhost URL http://localhost:1234.

Build and Deployement

A production build can be created using the command below for deployement. This command must be executed within the project directory.

npm run build

After executing the command, the source files will be compiled and stored in the /dist directory. When the build process finishes, it’s important to transfer all the files and directories from /dist to your web server.