Prospero Flow CRM
We made a free open source CRM. Our Community Edition (CE)
- Prospero Flow CRM is based in Laravel 13
Requirements
- PHP >= 8.4 / 8.5
- composer
- Laravel 13
- Docker
- MariaDB / MySQL / Postgres / MS SQL Server
- Redis
Features
- Multi company (White label)
- Multi-language
- REST API
Setup
Clone the project:
git clone [email protected]:Roskus/prospero-flow-crm.git
Migrate from hammer to prospero-flow-crm repo
git remote set-url origin [email protected]:Roskus/prospero-flow-crm.git
Docker Setup in 1 command
make install
Setup docker
With MariaDB
docker compose -f docker-compose.yml -f docker-compose.mariadb.yml -f docker-compose.pma.yml build
docker compose -f docker-compose.yml -f docker-compose.mariadb.yml -f docker-compose.pma.yml up -d
With MySQL
docker compose -f docker-compose.yml -f docker-compose.mysql.yml -f docker-compose.pma.yml build
docker compose -f docker-compose.yml -f docker-compose.mysql.yml -f docker-compose.pma.yml up -d
or
make build
make up
With Postgres
make build-pg
make up-pg
With MS SQL Server
make build-ms
make up-ms
Enter inside the container
docker exec -it crm-php /bin/bash
or
make ssh
Copy environment config file
cp .env.example .env
Edit your .env config file and set language, database
DB_PASSWORD=
Install dependencies:
composer install
Generate your APP_KEY
php artisan key:generate
Run migrations and seeders
php artisan migrate
php artisan db:seed
Generate JWT Secret
php artisan jwt:secret
Set Crontab
crotab -e
* * * * * cd /home/ubuntu/www/crm && php artisan schedule:run >> /dev/null 2>&1
Demo
- User: [email protected]
- Pass: admin123
API
We will provide a REST API for exchange information with the CRM
API Docs http://prosperoflow.localhost/api/documentation
Regenerate documentation
php artisan l5-swagger:generate
Endpoint: /api
Some API Endpoint for the full list check the doc:
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/auth |
User auth |
| GET | /api/lead |
Get all leads |
| GET | /api/lead/{id} |
Get lead detail |
| POST | /api/lead |
Create new lead |
| PUT | /api/lead/{id} |
Update existing lead |
| DELETE | /api/lead/{id} |
Delete a lead |
| GET | /api/customer |
Get all customers |
| POST | /api/customer |
Create new customer |
| GET | /api/product |
Get all products |
| POST | /api/product |
Create new product |
| GET | /api/order |
Get all orders |
| GET | /api/supplier |
Get all suppliers |
| GET | /api/ticket |
Get all tickets |
| GET | /api/ticket/{id} |
Get existing ticket |
| POST | /api/ticket |
Create support ticket |
Run tests
make test
Translation (i18n)
Check missing translation keys
php artisan translations:check --excludedDirectories=lang/vendor
PHPStan
Code quality check, find bugs
vendor/bin/phpstan analyse app tests
Spec Drive Development / AI Assistant(SDD)
OpenSpec
This project uses OpenSpec for spec-driven planning with AI assistants (Claude Code, Cursor, Copilot, etc.).
Install the CLI:
npm install -g @fission-ai/openspec@latest
Specs are stored in openspec/specs/ alongside the code and versioned with git.
Resources
Icon font Line Awesome https://icons8.com/line-awesome