CRM/backend/README.md

1012 B

CRM Backend

Laravel 12 API for the CRM. See the root README.md for full setup, testing, security, and project-structure notes.

Quick Start

composer install
copy .env.example .env
php artisan key:generate
type nul > database\database.sqlite
php artisan migrate --seed
php artisan serve --host=127.0.0.1 --port=8800

Required PHP extensions include gd, mbstring, openssl, pdo_sqlite, zip, xml, xmlreader, xmlwriter, simplexml, dom, fileinfo, and curl. Check the current machine with:

composer check-platform-reqs

Default local backend:

Host: 127.0.0.1
Port: 8800
URL:  http://127.0.0.1:8800

To use another port, pass a different --port to php artisan serve and update APP_URL, SANCTUM_STATEFUL_DOMAINS, CORS_ALLOWED_ORIGINS, and the frontend VITE_BACKEND_URL.

Run tests with:

php artisan test

Do not commit .env, database/*.sqlite, storage runtime data, bootstrap/cache output, cookie files, or vendor.