mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-25 17:33:19 +03:00
Code Issues Projects Releases Packages Wiki Activity

Added wiki content to the doc directory. The wiki pages will be deprecated and removed in the future.

Browse source
This commit is contained in:
Alex Tselegidis 2016-07-10 18:59:40 +02:00
parent abbb982edf
commit b7e8e0a25c
5 changed files with 123 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/get-involved.md Normal file
View file

@ -0,0 +1,17 @@
> Learn in which ways you can get involved with the project development!
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 E!A 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
Since version 1.0 Easy!Appointments supports custom language translations so that people that are not familiar with English can use the application more easily. If you want to help with the translation process download the "translations.xls" file and once done send it back to [alextselegidis@gmail.com](mailto:alextselegidis@gmail.com). The translation will be applied in E!A within the next release and you will be off course credited for your work.
Translation File: [translations.xls](https://www.dropbox.com/s/d5wzebzar3xllwj/translations.xls?dl=1)
### 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).

30
doc/google-calendar-sync.md Normal file
View file

@ -0,0 +1,30 @@
> This page will guide you through the activation of the Google Calendar synchronization feature.
Since version 1.0 Easy!Appointments supports two way synchronization with the Google Calendar API. Every provider can link his Google Calendar account with the application and make sure that any modification made on the schedule is synced between both systems. Easy!Appointments will add extra information (if available) to Google Calendar events so that users can check event participants, reply whether they will come or not etc. Once the events are on Google Calendar they can then be synced and used by other services that support Google’s API.
So, these are the required steps for enabling the Google Calendar Sync feature of Easy!Appointments:
1. **Working Easy!Appointments Installation**: the installation must be fully functional and configured and needs to have some services and providers.
2. **Google Calendar API Credentials**: The synchronization feature requires valid Google API credentials in order to be handle data with Google accounts. Some services have a maximum quota for their free use (fortunately the Calendar API provides 1.000.000 requests/day).
- Go to the Google Developers Console and create a new project.
- Select the "APIs & auth – APIs" menu and enable the Calendar API.
- Click on the "Credentials" menu item and create a client ID for your installation and a public API access key ("Create new Client ID" and "Create new Key" buttons). When editing the client ID the redirect URI to http://url/to/easyappointments/index.php/google/oauth_callback.
3. **Enable the Sync Feature**: Go to your config.php file and update the Google Calendar Sync section with your API credentials.
4. **Link Google Calendar and Easy!Appointments**: Go to backend/calendar page, select a provider and click on the "Enable Sync" button. A new window will pop up asking you to grant concern.
#### Note that ...
* Currently synchronization can be triggered only from the Easy!Appointments backend or when there are changes in the appointment plan.
* Every provider user can be synced with only one Google Calendar account.
* Recursive events are not supported yet.
#### Useful Links ...
Google Developers – https://developers.google.com/google-apps/calendar
E!A Support Group – https://groups.google.com/forum/#!forum/easy-appointments

27
doc/installation-guide.md Normal file
View file

@ -0,0 +1,27 @@
> This page will guide you through the installation and configuration of Easy!Appointments.
### Introduction
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.
1. **Make sure that your server has at least the following applications/tools installed: Apache(v2.4), PHP(v5.3) and MySQL(v5.5.24).** 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 premade 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/easy_appointments/" then the URL to this folder will be "http://your-domaThis 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.
### Configuration
When you finish the installation, Easy!Appointments will only contain an administrator user, a test service, a test provider and some default settings. You will need configure the system with your own business logic, but before that you can try adding a test appointment before proceeding with the following steps.
1. Head to backend section by entering the Easy!Appointments URL `http://installation-url/index.php/backend` in your browser. When logged in, click on the "Settings" menu item on top of the page. Click on the "Business Logic" tab and apply the working plan of your company. Press teh "Save" button when you are finished. This will be the default working plan for all new providers (not the existing ones).
2. Next you will need to add the services that your customers will book appointments for. You can optionally organize these services by using custom categories. Add some records and make sure you fill the required fields.
3. Once you are ready with the services you will need to add the service providers of your company. By doing so, customers will be able to select the employee they want to provide their preferred service, during the booking procedure. Hit the "Users" menu item and then the "Providers" tab. Add a new provider user and set his working plan and services. If you wish to assign the appointments without using Easy!Appointments just create a single general provider user named with your company name. It is not necessary for the provider to know the login credentials, but if he does, he will be able to view his appointment plan and sync it with his Google Calendar account.
4. If you have a secretary handling all the appointments for your company, hit the "Secretaries" tab and add a new user. Select the providers that she can manage and save the record. The secretary user will be able to manage the appointments only for the providers she is responsible.
5. That's it! Click on the "Go To Booking Page" link on the footer of the page and create a new appointment. The new appointment will be now be visible at the "Calendar" page of the backend section. The customer's data have also been saved and can be found in the "Customers" page.
Finally just add a link in your website that points to your Easy!Appointments installation with a caption similar to "Book Appointment". Whenever a customer clicks on that link he will be redirected the booking page.
Happy Bookin'!

38
doc/manage-translations.md Normal file
View file

@ -0,0 +1,38 @@
> This page will guide you through the management of Easy!Appointments translations.
### Introduction
Easy!Appointments supports the addition of custom translations in order to display the user interface into many languages and therefore be more user friendly. This page will guide you through the addition of a new translation and the configuration of the application. You can also modify the available translations or even set the default one for the application.
### Details
Easy!Appointments is based upon CodeIgniter (PHP Framework) and it uses its build-in libraries in order to translate the content into many languages. Version 1.1 of the application comes with English, German, Greek, Hungarian, Portuguese, Spanish, Italian, Japanese, Dutch, French, Simplified Chinese, Polish, Danish, Luxembourgish, Slovak, Finnish, Russian, Romanian, Turkish and Hindi already included, but there is also the ability to add you own translation and change the user interface strings and captions. To add a new translation you must do the following:
1. **CREATE A TRANSLATION FOLDER INSIDE "/APPLICATION/LANGUAGE/" DIRECTORY.** If you want for example to translate the application into French then you will need to create a new folder named "french" inside the `/application/language/` directory and copy the contents of the "english" folder. You must also copy the "migration_lang.php" file from another translation directory (e.g. "german") because CodeIgniter requires it when the version migration algorithm is executed.
2. **TRANSLATE EACH STRING WITHIN YOUR "TRANSLATION_LANG.PHP" FILE INTO YOUR LANGUAGE.** You will just have to replace the English strings with your translation. Example >> `$lang['page_title'] = 'Write your translation here!';`
3. **TELL EASY!APPOINTMENTS THAT YOU HAVE ADDED A NEW TRANSLATION.** When you are finished with the translation you will need to make some changes into the core config file of Easy!Appointments located at "/application/config/config.php" in order to tell the application that there is a new translation available. Find line 90 and add your language to the array. Example >> `$config['available_languages'] = array('english', 'german', 'greek', 'hungarian', 'portuguese', 'french');`. Then change the default language, though this is optional (e.g.` $config['language'] = 'english';`).
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.
### Available Translations
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/english.zip?dl=1" target="_blank">English (Alex Tselegidis)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/german.zip?dl=1" target="_blank">German (Stefan Tselegidis)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/greek.zip?dl=1" target="_blank">Greek (Alex Tselegidis)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/hungarian.zip?dl=1" target="_blank">Hungarian (Zsolt Zala)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/portuguese.zip?dl=1" target="_blank">Portuguese (Andre Tavares)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/spanish-hallar.zip?dl=1" target="_blank">Spanish (Karim Hallar)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/spanish-silva.zip?dl=1" target="_blank">Spanish (Cristian Silva)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/spanish-yoruba.zip?dl=1" target="_blank">Spanish (Obalogun Yoruba)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/dutch.zip?dl=1" target="_blank">Dutch (Marco Tielen)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/japanese.zip?dl=1" target="_blank">Japanese (Masashi Nakane)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/french.zip?dl=1" target="_blank">French (Bernard Sylvie)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/french%20-%20for%20beauty%20salons.zip?dl=1" target="_blank">French - For Beauty Salons (Bernard Sylvie)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/chinese.zip?dl=1" target="_blank">Simplified Chinese (Aaron Wong)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/polish.zip?dl=1" target="_blank">Polish (K.Januś)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/italian.zip?dl=1" target="_blank">Italian (Salvatore Cordiano)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/danish.zip?dl=1" target="_blank">Danish (Lars Juul)</a>
- <a href="https://www.dropbox.com/s/es6d16tv7hekiff/luxembourgish.zip?dl=1" target="_blank">Luxembourgish (Claudine Van Winckel-Weber)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/slovak.zip?dl=1" target="_blank">Slovak (Branislav Ďorď)</a>
- <a href="https://dl.dropboxusercontent.com/u/27545985/easyappointments/translations/finnish.zip?dl=1" target="_blank">Finnish (Joona Kannisto)</a>
- <a href="https://www.dropbox.com/s/4vms8y6h4y42ccg/russian.zip?dl=1" target="_blank">Russian (Roman Filippov)</a>
- <a href="https://www.dropbox.com/s/eg43v35ehuxmz5b/romanian.zip?dl=1" target="_blank">Romanian (Cosmin Raducanu)</a>
- <a href="https://www.dropbox.com/s/i6fsufcgrvoc945/turkish.zip?dl=1" target="_blank">Turkish (Burak Inal)</a>
- <a href="https://www.dropbox.com/s/fnd2ka43j26yg1c/hindi.zip?dl=1" target="_blank">Hindi (Sharon S.K. Nathaniel)</a>

11
doc/update-guide.md Normal file
View file

@ -0,0 +1,11 @@
This page will guide you through the update procedure of your Easy!Appointments installation. You will need to follow the steps below in order to have successful results.
1. **Backup** your files and database! This number one rule is very important for all computer systems and tools. If something breaks in your installation you might have a hard time to restore it without a backup.
2. **Copy** and replace the new Easy!Appointment version files in your installation directory WITHOUT REPLACING THE `config.php` FILE. This is the only file that does not need to be replaced in all versions.
3. **Open** your browser and head to the following URL `http://url-to-ea-installation/index.php/backend/update` (needs admin authorization). You should then see a "SUCCESS" message which means that your database has been successfully patched and you can now use the new version!
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.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!