mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-22 07:52:29 +03:00
Code Issues Projects Releases Packages Wiki Activity

Updated the documentation for v1.2.1

Browse source
This commit is contained in:
alext 2017-05-18 21:57:07 +02:00
parent 4ffc4aa6fd
commit a59726a993
9 changed files with 26 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -13,6 +13,7 @@ your existing website, because it can be installed in a single folder of the ser
both sites can share the same database.
### Features
The project was designed to be flexible and reliable so as to be able to meet the needs of any
kind of enterprise. You can read the main features of the system below:
@ -26,12 +27,14 @@ kind of enterprise. You can read the main features of the system below:
* User community support.
### Installation
Since Easy!Appointments is a web application, it runs on a web server and thus you will need to
perform the following steps in order to install the system on your server:
* Make sure that your server has Apache, PHP and MySQL installed.
* Create a new database (or use an existing).
* Copy the "easyappointments" source folder on your server.
* Ensure that the "storage" directory is writable.
* Rename the "config-sample.php" file to "config.php" and set your server properties.
* Open your browser on the Easy!Appointments URL and follow the installation guide.
* That's it! You can now use Easy!Appointments at your will.
@ -44,12 +47,14 @@ You can also report problems on the [issues page](https://github.com/alextselegi
and help the development progress.
### User Feedback
Whether it is new ideas or defects, your feedback is highly appreciated and will be taken into
consideration for the following releases of the project. Share your experience and discuss your
thoughts with other users through communities. Create issues with suggestions on new features or
bug reports.
### Translate Easy!Appointments
As of version 1.0 Easy!Appointments supports translated user interface. If you want to contribute to the
translation process read the [get involved](https://github.com/alextselegidis/easyappointments/wiki/Get-Involved!)
page for additional information.

2
doc/faq.md
View file

@ -45,6 +45,6 @@ The following link points to a common question that many users ask. The default
(https://groups.google.com/d/msg/easy-appointments/Mdt98fbF8hE/9CEjOvW7FAAJ)
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)

6
doc/get-involved.md
View file

@ -5,17 +5,21 @@
Easy!Appointments is an open source project and thus the connection with the users community is stronger than commercial projects. People can contribute in the development and spread of this project and make it even better so that they, themselves can take advantage of it in order to fulfill their business needs. Bellow are described the ways that you can help Easy!Appointments get better.
### Testing
The most important goal of Easy!Appointments is performance and stability and that means that **everything must work as expected**. Even though the project has been tested thoroughly during its Beta phase it is important that bugs are tracked down and are fixed as soon as possible.
### Suggestions
Everything you might suggest about the project will be taken into concern and is highly appreciated. Your ideas of new features and enhancements are very important and will help Easy!Appointments become even better. So do not hesitate to submit your suggestions and feature requests to [E!A Submission Form](http://easyappointments.org/submission.php)
### Translation
You are more than welcome to help with the translation progress of the user interface. The application is already translated into a big variety of languages but as new features are added new strings need to be translated. You can send your translations with a pull request in GitHub or per email to [alextselegidis@gmail.com](mailto:alextselegidis@gmail.com)
### User Feedback
It would be much appreciated if you would take 5 minutes of your time to fill this small form on your experience with Easy!Appointments. User feedback is very important and will help with the future planning of the project. Fill the [E!A Feedback Form](https://docs.google.com/forms/d/15dw1jl7lUgw4q-XXMn13Gx_e8zJxAiyWYMOdqtZqIHU/viewform).
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)

2
doc/google-calendar-sync.md
View file

@ -49,6 +49,6 @@ Google Developers – https://developers.google.com/google-apps/calendar
E!A Support Group – https://groups.google.com/forum/#!forum/easy-appointments
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)

11
doc/installation-guide.md
View file

@ -6,13 +6,14 @@
Easy!Appointments is a web appointment scheduler that can be installed and run in web servers. Users will be able to reach the application through their web browsers by using an active internet connection, just like visiting a normal website. The installation process is very similar to other popular web systems like WordPress and Joomla, so it is very likely that you will be familiar with the next steps. Follow this article strictly in order to complete the installation with no problems. After that, read the "Configuration" section for adjusting the system to fit your needs.
### Installation
There are 5 steps you must follow during the installation process.
There are 6 steps you must follow during the installation process.
1. **Make sure that your server has at least the following applications/tools installed: Apache(v2.4), PHP(v5.6) and MySQL(v5.5).** Easy!Appointments needs these programs to run. Most of the web hosting companies provide these tools within their Linux hosting plans. If you want to install Easy!Appointments on your local server use one of the pre-made bundles available on the web (XAMPP, MAMP, WAMP ...), all of which are free to use. If you plan to use the Google Calendar synchronization you will need the **php_curl** extension installed and enabled as well.
2. **Create a new database (or use an existing one).** The database is necessary for storing the system data. Therefore your hosting plan must include at least one MySQL database. You must also get the database administration credentials because they will be needed later on.
3. **Upload the Easy!Appointments source files to your server.** You can place the files into a directory with named "easyappointments" or "appointments" or "book" etc. Make sure that you mark the Easy!Appointments folder URL because it will be needed in the following step. For example if the system files are placed in the this directory ".../httpdocs/easyappointments/" then the URL to this folder will be "http://your-domain.com/easyappointments". This URL will be needed in the following step.
4. **Edit the "config.php" file and set your server properties.** Like other web systems Easy!Appointments needs to know how to connect to the database and the base URL of the installation. You can also provide the Google Calendar API keys in this file, if you want to use the Google Calendar Sync feature. NOTE that you will need to create an API key before that in the Google Cloud Console.
5. **Open a web browser and head to the Easy!Appointments installation folder URL.** The first time you open this page an installation guide will be shown. Fill in the administrator user and company settings and press the "Install" button. That's it! You can now use the application at your own will.
3. **Upload the Easy!Appointments source files to your server.** You can place the files into a directory with named "easyappointments" or "appointments" or "book" etc. Make sure that you mark the Easy!Appointments folder URL because it will be needed in the following step. For example if the system files are placed in the this directory ".../httpdocs/easyappointments/" then the URL to this folder will be "http://your-domain.com/easyappointments". This URL will be needed in the following steps.
4. **Ensure that the "storage" directory is writable.** Session information, logs and any other kind of files will land into the "storage" directory so make sure that it has the correct permissions and that is writable.
5. **Edit the "config.php" file and set your server properties.** Like other web systems Easy!Appointments needs to know how to connect to the database and the base URL of the installation. You can also provide the Google Calendar API keys in this file, if you want to use the Google Calendar Sync feature. NOTE that you will need to create an API key before that in the Google Cloud Console.
6. **Open a web browser and head to the Easy!Appointments installation folder URL.** The first time you open this page an installation guide will be shown. Fill in the administrator user and company settings and press the "Install" button. That's it! You can now use the application at your own will.
### Configuration
@ -28,6 +29,6 @@ Finally just add a link in your website that points to your Easy!Appointments in
Happy Bookin'!
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)

2
doc/manage-translations.md
View file

@ -14,6 +14,6 @@ Easy!Appointments is based upon CodeIgniter (PHP Framework) and it uses its buil
Follow these steps in order to add or adjust your translations and modify the message of the user interface of Easy!Appointments. If you want contribute to the translation process of Easy!Appointments please read the [Get Involved](https://github.com/alextselegidis/easyappointments/wiki/Get-Involved!) wiki page for more information. Please share your translations with the user community.
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)

2
doc/readme.md
View file

@ -10,4 +10,4 @@ Welcome to the documentation pages of Easy!Appointments. Navigate through the av
- [Get Involved!](get-involved.md)
- [FAQ](faq.md)
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.

2
doc/rest-api.md
View file

@ -433,6 +433,6 @@ fastcgi_param PHP_AUTH_PW $http_authorization;
[[Source]](http://serverfault.com/a/520943)
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)

6
doc/update-guide.md
View file

@ -8,10 +8,14 @@ This page will guide you through the update procedure of your Easy!Appointments
If by chance you get a 500 Internal Server Error message then you must check the error log files of your server. These kind of errors comes mostly due to problematic server configuration (permissions, credentials etc).
### Updating from v1.1.x to v1.2.x
Version v1.2 introduces two new folders in the root directory of the project, the "engine" and the "storage" directory. Ensure that the storage directory is writable and has the correct permissions.
### Updating from v1.0 to v1.1.x
Many core files were changed in v1.1 and it would be better if you replace all the Easy!Appointments files of version 1.0 with the new ones. Use the data of the old `configuration.php` file in the new `config.php` and open the `http://url-to-ea-installation/index.php/backend/update` as already mentioned. Your new version should work just fine!
*This document applies to Easy!Appointments v1.2*.
*This document applies to Easy!Appointments v1.2.1*.
[Back](readme.md)