Files
espocrm/README.md
Yurii Kuznietsov 9de57ba4b2 Update README.md
2024-05-30 19:41:22 +03:00

5.1 KiB
Raw Blame History

EspoCRM

PHPStan level 8

EspoCRM is a free, open-source CRM platform designed to help organizations build and maintain strong customer relationships. It provides a wide range of tools to store, organize, and manage leads, contacts, sales opportunities, marketing campaigns, support cases, and more all business information in a simple and intuitive interface.

Screenshot

Architecture

EspoCRM is a web application with a frontend designed as a single-page application and a REST API backend written in PHP.

Demo

You can try the CRM on an online demo.

Download

Download the lastest release from our website. You can also download the latest and previous release packages from GitHub releases.

Requirements

  • PHP 8.1 - 8.3;
  • MySQL 5.7 (and later), or MariaDB 10.2 (and later);
  • PostgreSQL 15 (and later) (beta, official support soon).

For more information about server configuration, see this article.

Why EspoCRM?

  • Open-source transparency. EspoCRMs source code is open and accessible, so anyone can inspect it and see how data is being managed within the CRM.
  • Customization freedom. You can develop features and create custom entities, fields, layouts, and buttons to make the CRM fit your specific needs.
  • Clean user interface. EspoCRM has a clean, uncluttered and minimalistic user inteface that is easy to navigate and has a short learning curve.
  • Straightforward REST API. It can be easily integrated with other applications using a well-documented REST API.

Who is EspoCRM for?

  • Startups, small & medium-sized businesses. Its an affordable solution that is flexible and fully customizable.
  • Developers & tech enthusiasts. You can extend functionalities, build extensions, and create custom integrations.
  • Anyone seeking a free CRM. If you're looking for a user-friendly and secure CRM platform, it can be a good option.

Release notes

Release notes are available at GitHub releases.

Documentation

See the documentation for administrators, users and developers.

Bug reporting

Create a GitHub issue or post on our forum.

Installing stable version

See installation instructions:

Development

See the developer documentation.

We highly recommend using an IDE for development. The backend codebase follows SOLID principles, utilizes interfaces, static typing and generics. We recommend to start learning EspoCRM from the Dependency Injection article in the documentation.

Metadata plays an integral role in the EspoCRM application. All possible parameters are described with a JSON Schema, meaning you will have autocompletion in the IDE. You can also find the full metadata reference in the documentation.

Community & Support

If you have a question regarding some features, need help or customizations, want to get in touch with other EspoCRM users, or add a feature request, please use our community forum. We believe that using the forum to ask for help and share experience allows everyone in the community to contribute and use this knowledge later.

License

EspoCRM is published under the GNU AGPLv3 license.

Contributing

Before we can merge your pull request, you need to accept our CLA here. See contributing guidelines.

Branches:

  • fix upcoming maintenance release; minor fixes should be pushed to this branch;
  • master develop branch; new features should be pushed to this branch;
  • stable last stable release.

Language

If you want to improve existing translation or add a language that is not available yet, you can contribute on our POEditor project. See instructions here. It may be reasonable to let us know about your intention to join the POEditor project by posting on our forum or via the contact form on our website.

Changes on POEditor are usually merged to the GitHub repository before minor releases.