91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
# Caramel CRM
|
|
|
|
**A simple, secure, and GOBD-compliant invoicing and customer management tool for small businesses and freelancers.**
|
|
|
|
|
|
|
|
Caramel CRM is an open-source web application designed for small businesses, freelancers, and non-balancing partnerships (GbRs). It provides an easy-to-use, secure, and GOBD-compliant solution for invoicing and customer management. Since 2025, e-invoicing has become mandatory in Germany, and Caramel CRM aims to bridge the gap for small businesses unprepared for this transition.
|
|
|
|
- **Self-hosted**: Run it on any web hosting service.
|
|
- **GOBD-compliant**: Ensures legal compliance for invoicing.
|
|
- **ZUGFeRD/XRechnung/Factur-X support**: Standardized e-invoicing formats.
|
|
- **AI-assisted CRM**: Helps with customer care and acquisition.
|
|
- **User-friendly**: Designed for non-technical users.
|
|
|
|
|
|
## Status
|
|
|
|
**Current Status: Prototype**
|
|
|
|
Caramel CRM is currently in the **prototype phase**. It provides basic invoicing and customer management features but is **not yet GOBD-compliant**. This project is actively being developed as part of the **Prototype Fund** application.
|
|
|
|
|
|
## ⚠️ Warning
|
|
|
|
**Do not use this software in production environments yet!**
|
|
|
|
- The prototype is **not GOBD-compliant** and lacks essential security audits.
|
|
- Data loss or legal non-compliance may occur.
|
|
- Use only for **testing and development purposes**.
|
|
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
- PHP 8.1+
|
|
- Composer
|
|
- Node.js (for frontend assets)
|
|
- SQLite/MySQL/PostgreSQL
|
|
|
|
### Steps
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://code.tooloop.de/Tooloop/Caramel-CRM.git
|
|
cd Caramel-CRM
|
|
````
|
|
2. Install dependencies:
|
|
```bash
|
|
composer install
|
|
npm install
|
|
```
|
|
3. Set up the environment:
|
|
```bash
|
|
cp .env.example .env
|
|
php artisan key\:generate
|
|
```
|
|
4. Run migrations and seeders:
|
|
```bash
|
|
php artisan migrate --seed
|
|
```
|
|
5. Build frontend assets:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
6. Start the development server:
|
|
```bash
|
|
php artisan serve
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Edit the .env file to configure your database, mail settings, and other environment-specific variables.
|
|
|
|
## Usage
|
|
|
|
1. Access the application at http://localhost:8000.
|
|
2. Log in with the default admin credentials (see .env for details).
|
|
3. Start creating invoices and managing customers.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions!
|
|
|
|
## License
|
|
Caramel CRM is open-source software licensed under the [MIT License](LICENCE).
|
|
|
|
## Contact
|
|
For questions or feedback, get in touch :-)
|
|
|
|
See all contact information on our wbsite at [Tooloop Multimedia](https://www.tooloop.de).
|
|
or find us in the Projekt-Matrix channel: [#caramel-crm:matrix.org](https://matrix.to/#/%23caramel-crm:matrix.org)
|