-
Notifications
You must be signed in to change notification settings - Fork 515
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #181 from sumitwebkul/qloImprove-readme
Readme file improvements with more information and links
- Loading branch information
Showing
1 changed file
with
74 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,91 @@ | ||
| QloApps | ||
| -------- | ||
| Hotel Commerce plays a vital role in hotel industry as it has changed the online presence of the hotels.QloApps also known as Qlo is a Hotel Commerce Software or you can say a Hotel Booking & Reservation System. Qlo is an open source and free platform which help you to launch your own hotel booking website and manage your online & On-Desk booking easily | ||
| <div align="center"> | ||
| <a href="https://www.qloapps.com"><img src="https://forums.qloapps.com/assets/uploads/system/site-logo.png?v=hkl8e1230fo" alt="QloApps"></a> | ||
| <br> | ||
| <p> | ||
| <b>QloApps - An open source and free platform to launch your own hotel booking website</b> | ||
| </p> | ||
| </div> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://qloapps.com/download/"><img src="https://img.shields.io/badge/Download-Download%20QloApps%20-brightgreen" alt="Download"></a> | ||
| <a href="https://qloapps.com/qlo-reservation-system/"><img src="https://img.shields.io/badge/Documentation-Blog-yellowgreen" alt="Documentation"></a> | ||
| <a href="https://forums.qloapps.com/"><img src="https://img.shields.io/badge/Forum-Help%2FSupport-green" alt="Forum"></a> | ||
| <a href="https://qloapps.com/addons/"><img src="https://img.shields.io/badge/Addons-Plugins-blueviolet" alt="Addons"></a> | ||
| <a href="https://qloapps.com/contact/"><img src="https://img.shields.io/badge/Contact-Get%20In%20Touch-blue" alt="Contact us"></a> | ||
| <a href="https://github.com/webkul/hotelcommerce/blob/develop/LICENSE"><img src="https://img.shields.io/badge/License-OSL%20V3-green" alt="License"></a> | ||
| </p> | ||
|
|
||
| Demo | ||
| -------- | ||
| FrontEnd : http://demo.qloapps.com </br> | ||
| Backend : http://demo.qloapps.com/adminhtl/index.php </br> | ||
| username : [email protected] </br> | ||
| Password : demodemo </br> | ||
| ## Topics | ||
| 1. [Introduction](#introduction) | ||
| 2. [Requirements](#requirements) | ||
| 3. [Installation & Configuration](#installation-and-configuration) | ||
| 4. [License](#license) | ||
| 5. [Security Vulnerabilities](#security-vulnerabilities) | ||
| 6. [Documentation & Demo](#documentation--demo) | ||
| 7. [Contribute](#contribute) | ||
| 8. [Credits](#credits) | ||
|
|
||
|
|
||
| Server configuration | ||
| -------- | ||
| To install Qlo, you need a web server running PHP 5.2+ and any flavor of MySQL 5.0+ (MySQL, MariaDB, Percona Server, etc) | ||
| You will also need a database administration tool, such as phpMyAdmin, in order to create a database for PrestaShop. | ||
| We recommend the Apache or Nginx web servers. | ||
| ### Introduction | ||
|
|
||
| QloApps also known as Qlo is an **Open-source and Free hotel reservation system** and booking engine. <br> | ||
| With the help of QloApps, you can launch your hotel booking website without any cost and take & manage online bookings . You can manage your online & On-Desk booking easily with QloApps. | ||
|
|
||
| Installation | ||
| -------- | ||
| a) from Source </br> | ||
| Please go through this blog : http://qloapps.com/install-qloapps/ for detail instruction about installation. | ||
| In nutshell : | ||
| Once the files in the QloApps archive have been decompressed and uploaded on your hosting space, go to the root of your QloApps directory with your web browser, and the QloApps installer will start automatically. Follow the instructions until QloApps is installed. | ||
| ### Requirements | ||
|
|
||
| b) Docker Image :</br> | ||
| https://github.com/webkul/qloapps_docker</br> | ||
| https://hub.docker.com/r/webkul/qloapps_docker/ </br> | ||
| 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. | ||
|
|
||
| c) Vagrant Image : | ||
| https://github.com/webkul/Vagrant_qloapps | ||
| #### Hosted Server Configurations | ||
|
|
||
| * **Web server**: Apache 1.3, Apache 2.x, Nginx or Microsoft IIS | ||
| * **PHP version**: 5.4+ | ||
| * **MySQL version**: 5.0+ and below 5.7 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**: cURL, SimpleXML, SOAP | ||
|
|
||
| Getting support | ||
| -------- | ||
| If you need help using QloApps, contact the QloApps support team: [email protected] | ||
| or raise ticket at https://webkul.uvdesk.com | ||
| #### Local Server Configurations | ||
|
|
||
| Webkul is known for his proactive support and already developed more than 100+ plugins on prestashop and more than 700+ plugins on other platforms. | ||
| * **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**: 5.4+ and below PHP 7.0 | ||
| * **MySQL** 5.0+ and below 5.7 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**: cURL, SimpleXML, SOAP | ||
|
|
||
| ### Installation and Configuration | ||
|
|
||
| license | ||
| -------- | ||
| OSL V3 : https://opensource.org/licenses/OSL-3.0 | ||
| **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) <br> | ||
| * Docker pull command | ||
| ~~~ | ||
| docker pull webkul/qloapps_docker | ||
| ~~~ | ||
|
|
||
| Credits | ||
| -------- | ||
| Crafted with :heart: at [Webkul](http://webkul.com) | ||
| ### License | ||
|
|
||
| QloApps is a truly opensource Hotel-Commerce platform which is under the [Open Software License 3.0](https://github.com/webkul/hotelcommerce/blob/develop/LICENSE). | ||
|
|
||
| Thank you for downloading. | ||
| ### Security Vulnerabilities | ||
|
|
||
| Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in QloApps then please email us: mailto:[email protected]. | ||
|
|
||
| ### Documentation & Demo | ||
|
|
||
| #### QloApps Documentation [https://qloapps.com/qlo-reservation-system](https://qloapps.com/qlo-reservation-system) | ||
| #### QloApps Demo | ||
| **FrontEnd** : https://demo.qloapps.com </br> | ||
| **Backend** : https://demo.qloapps.com/adminhtl/index.php </br> | ||
| **username** : [email protected] </br> | ||
| **Password** : demodemo </br> | ||
|
|
||
| ### 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.<br> | ||
| For more information about the contribution process please visit **[Contribute to QloApps](https://qloapps.com/how-to-contribute-to-qloapps-project/)** | ||
|
|
||
| ### Credits | ||
| Crafted with :heart: at [Webkul](https://webkul.com) |