<NME> DOCUMENTATION.md
<BEF> # App Framework - Documentation

## Introduction

App Framework supports your whole workflow to create amazing iOS and Material Apps with HTML, JavaScript and CSS. All the tricky stuff, which has to be done for each application, is done by App Framework. You could spend your time on what makes your App special.

To become comfortable with App Framework, you should check the requirements first, follow the workflow step by step afterwards and use the reference as a quick refresher later on.

If you want to contribute to App Framework itself, please read the contribution chapters.

For any open question, feature request or bug, please use our [issue list](https://github.com/scriptPilot/app-framework/issues).
  - [Firebase backend](#firebase-backend)
- Testing
- Deployment

Read less, code more - please open a ticket for any open question in our [issue list](https://github.com/scriptPilot/app-framework/issues).

  - [Configure .editorconfig file](docs/editorconfigFile.md)
  - [Configure .eslintrc file](docs/eslintrcFile.md)
  - [Configure .gitignore and .npmignore files](docs/ignoreFiles.md)
- [Design your application](docs/design.md)
- Develop your application
  - [App component](docs/app-component.md)
  - [Page components](docs/page-components.md)
  - [Routing](docs/routing.md)
  - [Global data object](docs/data-object.md)
  - [sortObject function](docs/sort-object.md)
  - [Language files](docs/language-files.md)
  - [Images](docs/images.md)
  - [Icon fonts](docs/icon-fonts.md)
  - [Extend Vue root object / own components / Framework7 init options](docs/extend-vue-root-object.md)
  - [Modules and scripts](docs/modules-and-scripts.md)
  - [Cordova plugins](docs/cordova-plugins.md)
  - [Cordova preferences](docs/cordova-preferences.md)
  - [Firebase backend](docs/firebase.md)
  - [Image upload component](docs/image-upload-component.md)
  - [State restoration](docs/state-restoration.md)
  - [Application style](docs/application-style.md)
  - [Status bar style](docs/status-bar-style.md)
- [Test your application](docs/test.md)
- [Build your application](docs/build.md)
- [Deploy your application](docs/deploy.md)
- [Backup your project](docs/backup.md)

## Reference

- [Project folder structure](docs/folder-structure.md)
- [Configuration options](docs/configuration.md)
- [CLI commands](docs/cli-commands.md)
- [Changelog](CHANGELOG.md)

## Contribution

These chapters are only for contributors of App Framework itself.

- [Requirements](docs/dev-requirements.md)
- [Way of working](docs/dev-way-of-working.md)
- [Folder structure](docs/dev-folder-structure.md)
- [Coding rules](docs/dev-coding-rules.md)
- [Trouble shooting](docs/dev-trouble-shooting.md)
- [Update vendor folder](docs/dev-update-vendor-folder.md)

If you set `deployDevRulesOnTesting: true`, on each test command (`npm run dev`, `npm run ios` and `npm run android`), the *database-rules.json* and *storage-rules.txt* files will be deployed to your second Firebase project.

---

> OLD DOCUMENTATION BELOW

## Requirements

## Project folder structure

The following project folder will be created by default.

```
├── app                         # App source folder
│   ├── images                  # App images
│   ├── pages                   # App page components
│   ├── app.vue                 # App main component
│   ├── config.js               # App configuration
│   ├── database-rules.json     # Firebase database rules
│   ├── icon.png                # App icon file (minimum size is 1024 pixel)
│   ├── routes.json             # App routes configuration
│   └── storage-rules.txt       # Firebase storage rules
├── build                       # Latest build files (do not modify)
├── design                      # Design templates (PDF, Power Point)
├── node_modules                # Installed node modules (do not modify)
├── snapshots                   # Project snapshots (for rollback)
├── .babelrc                    # Babel configuration file for ES2015 support
├── .gitignore                  # List of ignored files for Git commits
└── package.json                # Project information
```

## Configuration options


<MSG> project folder structure

<DFF> @@ -12,6 +12,9 @@
   - [Firebase backend](#firebase-backend)
 - Testing
 - Deployment
+- Overview - CLI commands
+- [Overview - Project folder structure](#overview---project-folder-structure)
+- Overview - Configuration options
 
 Read less, code more - please open a ticket for any open question in our [issue list](https://github.com/scriptPilot/app-framework/issues).
 
@@ -177,6 +180,29 @@ devFirebase: {
 
 If you set `deployDevRulesOnTesting: true`, on each test command (`npm run dev`, `npm run ios` and `npm run android`), the *database-rules.json* and *storage-rules.txt* files will be deployed to your second Firebase project.
 
+## Overview - Project folder
+
+The following project folder will be created by default.
+
+```
+├── app                         # App source folder
+│   ├── images                  # App images
+│   ├── pages                   # App page components
+│   ├── app.vue                 # App main component
+│   ├── config.js               # App configuration
+│   ├── database-rules.json     # Firebase database rules
+│   ├── icon.png                # App icon file (minimum size is 1024 pixel)
+│   ├── routes.json             # App routes configuration
+│   └── storage-rules.txt       # Firebase storage rules
+├── build                       # Latest build files (do not modify)
+├── design                      # Design templates (PDF, Power Point)
+├── node_modules                # Installed node modules (do not modify)
+├── snapshots                   # Project snapshots (for rollback)
+├── .babelrc                    # Babel configuration file for ES2015 support
+├── .gitignore                  # List of ignored files for Git commits
+└── package.json                # Project information
+```
+
 ---
 
 > OLD DOCUMENTATION BELOW
@@ -207,28 +233,7 @@ If you set `deployDevRulesOnTesting: true`, on each test command (`npm run dev`,
 
 ## Requirements
 
-## Project folder structure
-
-The following project folder will be created by default.
 
-```
-├── app                         # App source folder
-│   ├── images                  # App images
-│   ├── pages                   # App page components
-│   ├── app.vue                 # App main component
-│   ├── config.js               # App configuration
-│   ├── database-rules.json     # Firebase database rules
-│   ├── icon.png                # App icon file (minimum size is 1024 pixel)
-│   ├── routes.json             # App routes configuration
-│   └── storage-rules.txt       # Firebase storage rules
-├── build                       # Latest build files (do not modify)
-├── design                      # Design templates (PDF, Power Point)
-├── node_modules                # Installed node modules (do not modify)
-├── snapshots                   # Project snapshots (for rollback)
-├── .babelrc                    # Babel configuration file for ES2015 support
-├── .gitignore                  # List of ignored files for Git commits
-└── package.json                # Project information
-```
 
 ## Configuration options
 

{'addition_count': 26, 'commit_subject': 'project folder structure', 'deletion_count': 21, 'file_extension': '.md', 'lang': 'md', 'license': 'mit', 'repo_name': 'scriptPilot/app-framework'}