Merge pull request Qloapps#13 from abhishek-webkul/theme

Add sections Theme, Upgrade and CLI installation

Author: rohit053

README.md

@@ -0,0 +1,47 @@
+# QloApps Development Documentation
+
+The online version of this documentation is hosted at [https://devdocs.qloapps.com](https://devdocs.qloapps.com/).
+
+## Contribution guide
+
+Contributions are more than welcome! To start contributing to this documentation, you need to deploy it locally and make the required changes. Here is how to deploy:
+
+- Fork this repository.
+
+- Clone your fork.
+
+- Follow the [Install dependencies](#Install-dependencies) section.
+
+Before making a contribution using a pull request make sure:
+
+- If adding a new page, its topic has not been covered already.
+
+- To use proper terminology as used in this documentation when referring to parts of QloApps.
+
+- To use `kebab-case` when adding a new file. For example, `new-file-one.md`, `new-file-two.md` etc.
+
+Follow VuePress official guide at [https://vuepress.vuejs.org/guide](https://vuepress.vuejs.org/guide/) for further help.
+
+## Install dependencies
+
+- Clone the repository somewhere on your system:
+  ```
+  git clone https://github.com/Qloapps/qloapps-docs.git
+  ```
+
+- Switch to the `qloapps-docs` directory:
+  ```
+  cd qloapps-docs
+  ```
+
+- Install all dependencies:
+  ```
+  npm install
+  ```
+
+- Build and deploy your repository:
+  ```
+  npm run docs:dev
+  ```
+
+- Open your browser and go to [http://localhost:8080](http://localhost:8080).

docs/.vuepress/config.js

@@ -62,7 +62,7 @@ module.exports = {
                     ['database/', 'Structure'],
                     ['database/schema', 'Schema'],
                     ['database/db-class', 'Database Class'],
-                    ['database/db-query-class', 'Database Query Class'],
+                    ['database/db-query-class', 'Database DbQuery Class'],
                     ['database/object-model-class', 'Object Model Class'],
                 ]
             },
@@ -84,8 +84,8 @@ module.exports = {
                     ['module_development/folder-structure', 'Folder Structure'],
                     ['module_development/classes', 'Module classes'],
                     ['module_development/configuration', 'Adding a Configuration page'],
-                    ['module_development/Frontoffice-controller', 'Display Content in Front Office'],
-                    ['module_development/admin-controller', 'Manage Module through Admin Controler'],
+                    ['module_development/frontoffice-controller', 'Display Content in Front office'],
+                    ['module_development/admin-controller', 'Manage Module through Admin Controller'],
                     ['module_development/module-translations', 'Translations'],
                 ]
             },
@@ -94,25 +94,35 @@ module.exports = {
                 path: '/webservice/',
                 collapsable: true,
                 children: [
-                    ['webservice/enable_webservices', 'Enable Webservice'],
+                    ['webservice/enable-webservice', 'Enable Webservice'],
                     ['webservice/basic-topics', 'Basics | First Steps'],
                     ['webservice/qloapps-webservice-lib', 'QloApps Webservice Library'],
-                    ['webservice/advance-api-uses', 'Advance Api Uses'],
+                    ['webservice/advanced-api-uses', 'Advanced API Uses'],
                 ]
             },
             {
                 title: 'Theme',
                 path: '/theme/',
                 collapsable: true,
+                children: [
+                    ['theme/', 'Introduction'],
+                    ['theme/directory-structure', 'Directory Structure'],
+                    ['theme/creating-a-theme', 'Creating a Theme'],
+                    ['theme/designing-the-theme', 'Designing the Theme'],
+                    ['theme/theme-modules', 'Theme Modules'],
+                    ['theme/exporting-a-theme', 'Exporting a Theme'],
+                    ['theme/installing-a-theme', 'Installing a Theme'],
+                    ['theme/best-practices', 'Best Practices'],
+                ]
             },
             {
                 title: 'Testing',
                 path: '/testing/',
                 collapsable: true,
             },
             {
-                title: 'Updation & Migration',
-                path: '/updation_migration/',
+                title: 'Upgrade',
+                path: '/upgrade/',
                 collapsable: true,
             },
             {

docs/README.md

@@ -1,7 +1,7 @@
 ---
 home: true
 heroText: QloApps Development Documentation
-tagline: This document will help you to develop on QloApps to tailor the system as per your vision
+tagline: This documentation will help you develop on QloApps to tailor the system as per your vision
 actionText: Get Started →
 actionLink: /introduction/
 features:

docs/architecture/README.md

@@ -4,10 +4,10 @@ QloApps is built by following the traditional object-oriented PHP practices. It
 
 The custom framework is developed on [3-tier architecture.](https://en.wikipedia.org/wiki/Multitier_architecture#Three-tier_architecture)
 
-- **Object/data**. The files in the "classes" folder control the access of databases.
+- **Object/data**. The files in the `/classes` folder control the access of databases.
 
-- **Data control**. Files in the root folder control User-generated content.
+- **Data control**. Files in the root folder control user-generated content.
 
-- **Design**. The "themes" folder contains the entirety of the theme's files are in.
+- **Design**. The `/themes` folder contains the entirety of the theme's files.
 
-This is the same as the MVC architecture but it is simpler and more accessible.
+This is the same as the MVC architecture but it is simpler and more accessible.

docs/architecture/directory-structure.md

@@ -1,94 +1,94 @@
 #  Directory Structure
 
-Following is the directory structure of QloApps
-
+Following is the directory structure of QloApps:
 
 ::: dir
-├── Adapter
-├── admin
-│   ├──autoupgrade
-│   ├──backups
-│   ├──export
-│   ├──filemanager
-│   ├──import
-│   └── themes
-├── cache
-├── classes
-├── config
-├── controllers
-│   ├── admin
-│   └── front
-├── Core
-├── css
-├── docs
-├── download
-├── img
-├── install
-├── js
-│   └── jquery
-├── localization
-├── log
-├── mails
-├── modules
-├── override
-│   ├── classes
-│   ├── controllers
-│   │   ├── admin
-│   │   └── front
-│   └── modules
-├── pdf
-├── themes
-├── tools
-├── translations
-├── upload
-└── webservice
+.
+├──  hotelcommerce
+│    ├── Adapter
+│    ├── admin
+│    │   ├──autoupgrade
+│    │   ├──backups
+│    │   ├──export
+│    │   ├──filemanager
+│    │   ├──import
+│    │   └── themes
+│    ├── cache
+│    ├── classes
+│    ├── config
+│    ├── controllers
+│    │   ├── admin
+│    │   └── front
+│    ├── Core
+│    ├── css
+│    ├── docs
+│    ├── download
+│    ├── img
+│    ├── install
+│    ├── js
+│    │   └── jquery
+│    ├── localization
+│    ├── log
+│    ├── mails
+│    ├── modules
+│    ├── override
+│    │   ├── classes
+│    │   ├── controllers
+│    │   │   ├── admin
+│    │   │   └── front
+│    │   └── modules
+│    ├── pdf
+│    ├── themes
+│    ├── tools
+│    ├── translations
+│    ├── upload
+│    └── webservice
 :::
 
 
 ## Folder reference
 
 ### /Adapter
-Contains the default adapter classes providing an interface to interact with Db, entity, hooks used in QloApps, and much more. 
+Contains the default adapter classes providing an interface to interact with Db, entity, hooks used in QloApps, and much more.
 
 ### /admin
 
-The admin directory contains the main endpoint to access the Back Office. When accessing this folder with your browser, you will be asked for your employee credentials.
-This directory is renamed automatically when you install it from a ZIP package and access it for the first time. 
+The admin directory contains the main endpoint to access back office. When accessing this folder with your browser, you will be asked for your employee credentials.
+This directory is renamed automatically when you install it from a ZIP package and access it for the first time.
 
 It contains the following subdirectories:
 
 - `/autoupgrade`: scratch directory for the 1-click upgrade module
-- `/backups`: contains database backups generated from the back-office
+- `/backups`: contains database backups generated from the back office
 - `/export`: contains data export files
-- `/filemanager`: sources for the back-office file manager
+- `/filemanager`: sources for the back office file manager
 - `/import`: contains data import files
-- `/themes`: contains the templates for two back-office themes, default and new-theme
+- `/themes`: contains templates for back office theme **default**
 
 
 ### /cache
 
-Contains temporary cache files. No longer used by QloApps but kept for backward compatibility.
+Contains temporary cache files.
 
 ### /classes
-Contains all the legacy classes, including:
+Contains all the classes, including:
 
 - Object models
 - Utility classes (like Db, Helper, Tools…)
 - Base controllers (like FrontController, AdminController…)
 
-
 ### /config
 
 Contains bootstrapping and configuration files. Unless asked, you should never edit them, as they are directly handled by QloApps’ installer and back office.
 
 ### /controllers
-It Contains controllers – as in MVC (Model-View-Controller), the software architecture used by QloApps. Each file controls a specific part of QloApps.
+It contains controllers – as in MVC (Model-View-Controller), the software architecture used by QloApps. Each file controls a specific part of QloApps.
 
-- `/admin`: contains legacy controllers for the Back Office
-- `/front`: contains controllers for the Front Office
+- `/admin`: contains controllers for the back office
+- `/front`: contains controllers for the front office
 
 ### /Core
-This folder contains a new architecture design to provide easier modularity to code and unit testing.  
+This folder contains a new architecture design to provide easier modularity to code and unit testing.
 
 ### /css
 This folder used to contain style sheets for jquery plugins, now those files are moved to the /js/jquery directory.
@@ -98,7 +98,7 @@ Contains documentation files, licenses, sample import files, and more.
 
 ### /download
 
-Contains files that can be downloaded by the customers. Files are stored with an md5 filename.
+Contains files that can be downloaded by customers. Files are stored with an md5 filename.
 
 ### /img
 
@@ -109,7 +109,7 @@ Contains all of QloApps’ default images, icons and, picture files – which do
 - `/cms`: CMS pictures
 - `/co`: Attributes (colors) pictures
 - `/flags`: Country & language flags
-- `/genders`: Gender (Shop Parameters > Customers > Client titles) pictures
+- `/genders`: Genders (Customers > Titles) pictures
 - `/jquery`-ui: jQuery UI images
 - `/l`: Language pictures
 - `/os`: Order state pictures
@@ -134,17 +134,17 @@ This is where you can find the jQuery framework.
 Contains all of QloApps localization packs — that is, files that contain local information such as default currencies and languages, tax rules and tax rule groups, states used in each country.
 
 ### /log
-This directory contains exception logs generated in QloApps
+This directory contains exception logs generated by QloApps.
 
 ### /mails
 
-Contains all HTML and text templates for e-mails sent by QloApps. Every language has its specific folder, where you can manually change the content. QloApps contains a tool to edit your e-mails, located in the back office, in the Localization > translations page.
+Contains all HTML and text templates for e-mails sent by QloApps. Every language has its specific folder, where you can manually change the content. QloApps contains a tool to edit your e-mails, located in the back office, in the **Localization > Translations** page.
 
 ### /modules
-Contains all of the QloApps modules, each in its folder.
+Contains all of the QloApps modules, each in its own folder.
 
 ### /override
-This directory contains the overridden classes. The overriding is done through modules or manually to change the behavior of legacy classes without actually changing them.
+This directory contains the overridden classes. The overriding is done through modules or manually to change the behavior of core classes without actually changing them.
 
 ### /pdf
 
@@ -154,17 +154,16 @@ Contains all the template files (.tpl) related to PDF file generation (invoice,
 
 It contains all the themes that you have installed. Each theme will be in its specific folder.
 
-
 ### /tools
-This directory contains all the 3rd party library used in QloApps.
+This directory contains all the 3rd party libraries used in QloApps.
 
 ### /translations
 
-Contains zip packages that you downloaded for the translation packs.
+Contains zip packages that you downloaded for translation packs.
 
 ### /upload
-This directory contains the files uploaded by the customer through the contact page or customizations.
+This directory contains files uploaded by the customer through the contact page or customizations.
 
 ### /webservice
 
-Provides the Webservice API's main Endpoint.
+Provides the Webservice API's main endpoint.

docs/architecture/technical.md

@@ -4,11 +4,11 @@
 - **View End**: HTML, CSS, JS
 - **Language Used**: PHP
 - **Database**: MySQL, XML
-- **Template Engine**: SMARTY
+- **Template Engine**: Smarty
 - **Technology**: JavaQuery, SASS, Bootstrap
 
 
-## MVC (Model–view–controller)
+## MVC (Model–View–Controller)
 [MVC](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) is a software design pattern containing three main logical components.
 
 Each of these parts is worked to deal with explicit advancement parts of an application. MVC is one of the most habitually utilized industry-standard web improvement systems to make adaptable and extensible systems.
@@ -23,6 +23,6 @@ The View part is utilized for all the UI logics of the application. For instance
 
 ### Controller
 
-Controllers go about as an interface among Model and View segments to handle all the business logics and approaching solicitations, control data utilizing the Model segment and cooperate with the Views to deliver the last yield.
+Controllers go about as an interface between Model and View segments to handle all the business logics and approaching solicitations, control data utilizing the Model segment and cooperate with the Views to deliver the last yield.
 
 For instance, the Customer controller will deal with all the cooperations and contributions from the Customer View and update the database utilizing the Customer Model. A similar controller will be utilized to see the Customer data.

docs/assets/images/theme/select-file-location.png

@@ -32,7 +32,7 @@ Again we are using the Github PR system to take the bug fixings.
 
 ### Optimization
 
-If you have an idea to make the system more optimized and you can make the system work better then its time to make a pull request at the QloApps Github repository.
+If you have an idea to make the system more optimized and you can make the system work better then its time to make a pull request at the [QloApps Github repository](https://github.com/webkul/hotelcommerce).
 
 The better-written code the better is the software performance.
 
@@ -55,7 +55,7 @@ Every release goes through a process of quality analysis before reaching you. Bu
 
 So we need you to report any bug you find in the system to our QA Team. Our team will check the bug and find the best possible solution to resolve it.
 
-You can report a bug either on our Github repository or on our [Forum](http://forums.qloapps.com/).
+You can report a bug either on our [Github repository](https://github.com/webkul/hotelcommerce) or on our [Forum](http://forums.qloapps.com/).
 
 ### Implementing Testing Tools