SuiteCRM-Core/README.md

2.5 KiB

SuiteCRM Logo

SuiteCRM 8.0-alpha

SuiteCRM is the award-winning open-source, enterprise-ready Customer Relationship Management (CRM) software application.

Our vision is to be the most adopted open source enterprise CRM in the world, giving users full control of their data and freedom to own and customise their business solution.

Try out a free fully working SuiteCRM demo available here

License AGPLv3

SuiteCRM is published under the AGPLv3 license.

Quick Start Guide

System Requirements

Requirement Version Database Version
PHP 7.2+ MariaDB 10.2+
Angular 9 MySQL 5.6-5.7
Node.js 10 SQL Server 2012+
Apache 2.4

Installation

1: Run composer install or for production composer install --no-dev in the root directory
2: Run npm install in the root directory
3: Run composer install or for production composer install --no-dev in legacy directory
4: Run legacy theme compile in legacy directory

./vendor/bin/pscss -f compressed themes/suite8/css/Dawn/style.scss > themes/suite8/css/Dawn/style.css
./vendor/bin/pscss -f compressed themes/suite8/css/Noon/style.scss > themes/suite8/css/Noon/style.css

5: Set permissions

chown -R {user ID}:{web user group} .
find . -type d -exec chmod 0755 {} \;
find . -type f -exec chmod 0644 {} \;
chmod +x bin/console

6: Run legacy install process
7: Go back to root folder
8: Run composer dump-env dev or for production composer dump-env prod
9: Set the place-holders in .env.local.php to valid credentials

'DATABASE_URL' => 'mysql://user:pass@db_host:db_port/db_name?serverVersion=db_version',

10: Setup proxy config if you plan to use ng serve - (Currently this does not do anything)

  • Copy proxy.conf.env.json to proxy.conf.local.json
  • Replace "target": "http//<api_host>:<api_port>" with your api url

11: Run ng build or ng serve or for production run ng build --prod or ng serve --prod
12: Run composer dumpautoload
13: Re-set permissions

chown -R {user ID}:{web user group} .
find . -type d -exec chmod 0755 {} \;
find . -type f -exec chmod 0644 {} \;
chmod +x bin/console