crm-summit/README.md

65 lines
1.3 KiB
Markdown
Raw Normal View History

# CRM Summit
2025-08-15 11:38:41 +07:00
CRM Summit is a CodeIgniter 4 app for CRM, service, product, certificate, and support workflows.
2025-08-15 11:38:41 +07:00
## Main modules
2025-08-15 11:38:41 +07:00
- Auth and user management
- Dashboard
- Accounts, sites, offices, zones, and areas
- Products, product types, services, aliases, catalogs, and temp import flow
- Activities, emails, contacts, and mail groups
- Bugs and bug comments
- Certificates: maintenance, installation, training
- Guidebook and inventory counters/transactions
- Integrations and sync jobs for Figma and Gitea
2025-08-15 11:38:41 +07:00
## Tech stack
2025-08-15 11:38:41 +07:00
- PHP 8.1+
- CodeIgniter 4
- MySQL/MariaDB
- dompdf for PDF output
- endroid/qr-code for QR generation
- ramsey/uuid for UUID support
2025-08-15 11:38:41 +07:00
## Setup
1. Install dependencies:
2025-08-15 11:38:41 +07:00
```bash
composer install
```
2025-08-15 11:38:41 +07:00
2. Copy `env` to `.env` and set app and database values:
2025-08-15 11:38:41 +07:00
```bash
copy env .env
```
2025-08-15 11:38:41 +07:00
3. Set `app.baseURL` for local or production host.
2025-08-15 11:38:41 +07:00
4. Point web server to `public/` folder.
2025-08-15 11:38:41 +07:00
5. Run migrations if project uses them:
2025-08-15 11:38:41 +07:00
```bash
php spark migrate
```
2025-08-15 11:38:41 +07:00
## Development commands
2025-08-15 11:38:41 +07:00
```bash
php spark list
php spark cache:clear
php spark migrate
php spark migrate:rollback
vendor\bin\phpunit
```
2025-08-15 11:38:41 +07:00
## Notes
2025-08-15 11:38:41 +07:00
- `index.php` lives in `public/` for security.
- Check `app/Config/Routes.php` for module URLs and entry points.
- Use `app/Config/` and `.env` for environment-specific settings.