# AppUI Documentation

Thank you for purchasing license of AppUI Template. If you have questions regarding this template that are beyond the scope of documentation, please feel free to contact us via email: rustheme@mail.com

## Overview

AppUI is a professional HTML5/CSS3 template. It is built on Bootstrap grid system, uses Sass for compiling CSS, Nunjucks template language for HTML rendering and Gulp for automating these tasks.

## Updating

AppUI is in active and ongoing development so in the future you will get a lot of free updates with new awesome features added, new fresh pages designed as well as third-party plugin upgraded. One of our goals was to make sure the update process is going to be as easy as possible.

So please keep in mind these rules when editing template files:

- Please write your own javascript functions in `app-custom.js` file. Don't touch core js files like `app.js` or pages (add your own with unique name). So after update you will just replace `app-custom.js` with your own file, without losing your progress.
- The same applies to CSS / Sass. Please write your CSS / make design changes in `app-custom.scss` file.
- AppUI HTML pages primarily comes as demo and they are tend to be overwriten with time. Creating your own pages and writing content there will ensure you won't lose your progress.

And always don't forget to make backup of your files before update!

## Download package

Let's have a look at the current AppUI package. After unzipping downloaded file you will have these 3 folders:

- `dist`

  Contains production ready files (JavaScript, compiled CSS, HTML, compressed images files) that you can manually edit for matching your needs.

- `src`

  Contains raw, source files (Gulpfile.js, Nunjucks templates, Sass files etc.) that you can use to build custom template with AppUI workflow.

- `documentation`

  Obviously, includes current documentation.

Visual hierarchy and short description of package folders is shown below:

#### Download package

- ---- dist // Production ready files
  - ---- assets
  - ---- `index.html`
  - ---- `..`
- ---- src // Raw, source files
  - ---- data // Json files (used for demo purposes)
  - ---- fonts // Icon fonts - copied to `dist/assets/fonts`
  - ---- img // Images - they'll be compressed and copied to `dist/assets/img`
  - ---- js // Javascript files and plugins - copied to `dist/assets/js`
  - ---- scss // Sass files - compiled as *.css files to `dist/assets/css`
  - ---- templates // Nunjucks templates
    - ---- _layout
    - ---- `index.html`
    - ---- `..`
  - ---- `gulpfile.js` // gulpfile.js - Gulp file, defines project structure and automated tasks
  - ---- `package.json` // package.json - defines Node.js dependencies
- ---- documentation

Before you can start customizing template with AppUI workflow, you should make some Installation steps.