From b66dcec036bae28740d004d890d1976802ed0b1a Mon Sep 17 00:00:00 2001 From: sumit panwar Date: Sat, 16 Jan 2021 17:18:11 +0530 Subject: [PATCH 1/2] Readme file improvements with more information and links --- README.md | 111 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 74 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 659ca2b3e..fca645fc1 100644 --- a/README.md +++ b/README.md @@ -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 +
+ QloApps +
+

+ QloApps - An open source and free platform to launch your own hotel booking website +

+
+

+ Download + Documentation + Forum + Addons + Contact us + License +

-Demo --------- -FrontEnd : http://demo.qloapps.com
-Backend : http://demo.qloapps.com/adminhtl/index.php
-username : demo@demo.com
-Password : demodemo
+## 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.
+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
-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 :
-https://github.com/webkul/qloapps_docker
-https://hub.docker.com/r/webkul/qloapps_docker/
+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: qloapps@webkul.com -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)
+* 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 will always be free under the [MIT License](https://github.com/webkul/hotelcommerce/blob/develop/LICENSE). -Thank you for downloading. \ No newline at end of file +### 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://qloapps.com/qlo-reservation-system](https://qloapps.com/qlo-reservation-system) +#### QloApps Demo +**FrontEnd** : https://demo.qloapps.com
+**Backend** : https://demo.qloapps.com/adminhtl/index.php
+**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 visit **[Contribute to QloApps](https://qloapps.com/how-to-contribute-to-qloapps-project/)** + +### Credits +Crafted with :heart: at [Webkul](https://webkul.com) From d5a288154d11d0d46a038cffc22aeee1b7dc1460 Mon Sep 17 00:00:00 2001 From: Sumit Panwar Date: Thu, 4 Feb 2021 12:08:21 +0530 Subject: [PATCH 2/2] Update License information --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fca645fc1..da0977253 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Forum Addons Contact us - License + License

## Topics @@ -68,7 +68,7 @@ docker pull webkul/qloapps_docker ### License -QloApps is a truly opensource Hotel-Commerce platform which will always be free under the [MIT License](https://github.com/webkul/hotelcommerce/blob/develop/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). ### Security Vulnerabilities