Added composer instructions to README.md

This commit is contained in:
Alex Tselegidis 2015-10-21 22:32:53 +02:00
parent 056e9c1165
commit af226f5e83

View file

@ -5,15 +5,15 @@ Easy!Appointments
### Organize your business! Exploit human resources that can be used in other tasks more efficiently.
**Easy!Appointments** is a highly customizable web application that allows your customers to book
appointments with you via the web. Moreover, it provides the ability to sync your data with
Google Calendar so you can use them with other services. It is an open source project and you
can download and install it **even for commercial use**. Easy!Appointments will run smoothly with
your existing website, because it can be installed in a single folder of the server and of course,
**Easy!Appointments** is a highly customizable web application that allows your customers to book
appointments with you via the web. Moreover, it provides the ability to sync your data with
Google Calendar so you can use them with other services. It is an open source project and you
can download and install it **even for commercial use**. Easy!Appointments will run smoothly with
your existing website, because it can be installed in a single folder of the server and of course,
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
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 the read the main features of the system below:
* Full customers and appointments management.
@ -24,7 +24,7 @@ kind of enterprise. You can the read the main features of the system below:
* Stand alone installation (like WordPress, Joomla! and other web systems).
### Installation
Since Easy!Appointments is a web application, it runs on a web server and thus you will need to
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.
@ -37,12 +37,15 @@ perform the following steps in order to install the system on your server:
You will find the latest release at [easyappointments.org](http://easyappointments.org). If you have problems installing or configuring the application take a look on the [wiki pages](https://github.com/alextselegidis/easyappointments/wiki) or visit the [official support group](https://groups.google.com/forum/#!forum/easy-appointments). You can also report problems on the [issues page](https://github.com/alextselegidis/easyappointments/issues) 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
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. Please take your time to fill this quick [feedback form](https://docs.google.com/forms/d/15dw1jl7lUgw4q-XXMn13Gx_e8zJxAiyWYMOdqtZqIHU/viewform#start=openform) about the project. You can also submit new feature requests on the [feature request page]
(http://easyappointments.org/submission.php).
### Translate E!A
As of version 1.0 Easy!Appointments supports translated user interface. If you want to contribute to the
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.
### Setup GitHub Files
If you download/clone the project from GitHub you will have to install the composer dependencies. To do so download and install [composer](http://getcomposer.org) and execute the `composer install` command at the project's root directory. This command is going to create the `application/third_party/autoload.php` and the other vendor files needed by the app.