/espocrm

EspoCRM open source CRM application

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

EspoCRM

EspoCRM is an Open Source CRM (Customer Relationship Management) software that allows you to see, enter and evaluate all your company relationships regardless of the type. People, companies or opportunities - all in an easy and intuitive interface.

It's a web application with a frontend designed as a single page application based on backbone.js and a REST API backend written in PHP.

Download the latest release from our website.

How to report bug

Create an issue here or post on our forum.

How to get started (for developers)

  1. Clone repository to your local computer.
  2. Change to the project's root directory.
  3. Install composer.
  4. Run composer install if composer is installed globally or php composer.phar install if locally.

Never update composer dependencies if you are going to contribute code back.

Now you can build.

If your repository is accessible via a web server then you can run EspoCRM by url http://PROJECT_URL/frontend. To compose a proper config.php and populate database you can run install by opening http(s)://{YOUR_CRM_URL}/install location in a browser. Also you need to run build before to have compiled css.

How to build

You need to have nodejs and Grunt CLI installed.

  1. Change to the project's root directory.
  2. Install project dependencies with npm install.
  3. Run Grunt with grunt.

The build will be created in the build directory.

How to make translation

Build po file with command: node po.js en_EN (specify needed language instead of en_EN)

After that tranlate the generated po file.

Build json files from the translated po file:

  1. Put your po file espocrm-en_EN.po to the build directory
  2. Run node lang.js en_EN

The files will be created in build directory.

License

EspoCRM is published under the GNU GPLv3 license.