## 1. Project Overview & Quickstart (Qloapps/QloApps) ## Topics - [Topics](#topics) - [Introduction](#introduction) - [Requirements](#requirements) - [Hosted Server Configurations](#hosted-server-configurations) - [Local Server Configurations](#local-server-configurations) - [Installation and Configuration](#installation-and-configuration) - [License](#license) - [Security Vulnerabilities](#security-vulnerabilities) - [Documentation & Demo](#documentation--demo) - [QloApps Documentation](#qloapps-documentation) - [QloApps Demo](#qloapps-demo) - [Contribute](#contribute) - [Credits](#credits) ### Introduction QloApps is one kind of a true open-source hotel reservation system and a booking engine. The system is dedicated to channeling the power of the open-source community to serve the hospitality industry. From small independent hotels to big hotel chains, QloApps is a one-stop solution for all your hotel business needs. You will be able to launch your hotel website, showcase your property and take and manage bookings. ### Requirements In order to install QloApps you will need the following server configurations for hosted and local serves. The system compatibility will also be checked by the system with installation and if the server is not compatible then the installation will not move ahead. #### Hosted Server Configurations * **Web server**: Apache 1.3, Apache 2.x, Nginx or Microsoft IIS * **PHP version**: PHP 8.1+ to PHP 8.4 * **MySQL version**: 5.7+ to 8.4 installed with a database created * SSH or FTP access (ask your hosting service for your credentials) * In the PHP configuration ask your provider to set memory_limit to "128M", upload_max_filesize to "16M" , max_execution_time to "500" and allow_url_fopen "on" * SSL certificate if you plan to process payments internally (not using PayPal for instance) * **Required PHP extensions**: PDO_MySQL, cURL, OpenSSL, SOAP, GD, SimpleXML, DOM, Zip, Phar #### Local Server Configurations * **Supported operating system**: Windows, Mac, and Linux * **A prepared package**: WampServer (for Windows), Xampp (for Windows and Mac) or EasyPHP (for Windows) * **Web server**: Apache 1.3, Apache 2.x, Nginx or Microsoft IIS * **PHP**: PHP 8.1+ to PHP 8.4 * **MySQL** 5.7+ to 8.4 installed with a database created * In the PHP configuration, set memory_limit to "128M", upload_max_filesize to "16M" and max_execution_time to "500" * **Required PHP extensions**: PDO_MySQL, cURL, OpenSSL, SOAP, GD, SimpleXML, DOM, Zip, Phar ### Installation and Configuration **1.** You can install QloApps easily after downloading QloApps. There are easy steps for the installation process. Please visit [QloApps Installation Guide](https://qloapps.com/install-qloapps/) and follow the steps for the successful installation. **2.** Or you can install QloApps with docker image. For the docker image of QloApps, please visit [Dockerize image of QloApps](https://hub.docker.com/r/webkul/qloapps_docker) * Docker pull command ~~~ docker pull webkul/qloapps_docker ~~~ ### License QloApps Core is licensed under OSL-3.0 and Modules authored by Webkul have their applicable license, LICENSE.md, kept inside their root directories, while other modules are licensed under AFL-3.0. The online copy of OSL-3.0 can be found at [https://opensource.org/licenses/OSL-3.0](https://opensource.org/licenses/OSL-3.0). The online copy of AFL-3.0 can be found at [https://opensource.org/licenses/AFL-3.0](https://opensource.org/licenses/AFL-3.0). ### Security Vulnerabilities Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in QloApps then please email us: mailto:support@qloapps.com. ### Documentation & Demo #### QloApps Documentation [https://docs.qloapps.com](https://docs.qloapps.com) #### QloApps Demo **Link** : https://demo.qloapps.com **username** : demo@demo.com **Password** : demodemo ### Contribute As a PHP developer who has command on PHP and MySQL and also knows how to use Git or GitHub efficiently, can contribute to code enhancements via pull requests. For more information about the contribution process please check **[Contribute to QloApps](/CONTRIBUTING.md)** ### Credits Crafted with :heart: at [Webkul](https://webkul.com) ## 2. Official Technical Reference & Guides (Qloapps/QloApps-docs) ## File: README.md # 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). --- ## File: docs/README.md --- home: true heroText: QloApps Development Documentation tagline: This documentation will help you develop on QloApps to tailor the system as per your vision actionText: Get Started → actionLink: /introduction/ features: - title: Core Development details: Learn how you can make changes in the core to customize the system. - title: Theme and Module Development details: Learn how to create themes and modules for QloApps. - title: API Documentation details: Learn how to integrate your systems with QloApps via APIs. --- ::: slot footer :::