Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bastianallgeier/letter
Letter is a simple, highly customizable tool to create letters in your browser.
https://github.com/bastianallgeier/letter
Last synced: about 2 months ago
JSON representation
Letter is a simple, highly customizable tool to create letters in your browser.
- Host: GitHub
- URL: https://github.com/bastianallgeier/letter
- Owner: bastianallgeier
- License: mit
- Created: 2017-01-16T11:02:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-22T17:29:13.000Z (over 2 years ago)
- Last Synced: 2024-07-21T04:48:45.677Z (2 months ago)
- Language: PHP
- Homepage: https://bastianallgeier.com/projects/letter/
- Size: 339 KB
- Stars: 476
- Watchers: 23
- Forks: 39
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Letter
Letter is a simple, highly customizable tool to create letters in your browser.
Instead of messing around in Word, Pages or even Indesign, you can write your letters in the browser, export them as HTML or PDF (via Apple Preview).
Written in plain HTML, CSS and some PHP, Letter can be installed in seconds and run either on your machine with PHP's built-in server, something like MAMP or on a server.
You can setup your own letter template and customize the design with CSS.
## Demo
This is how Letter looks like: https://bastianallgeier.com/projects/letter/
## Installation
### PHP's built-in server
```
git clone https://github.com/bastianallgeier/letter.git
cd letter
php -S localhost:8888
```
### MAMP
1. Download Letter and move it to the htdocs folder of your MAMP installation.
2. Open http://localhost/letter in your browser
## How to…
### Save Letters
You can save your letters by simply using the browser save dialog. Make sure to choose "Save HTML only" as the export option. You will get a nice and clean HTML file of your letter, which can be kept for later at any place you prefer.
### Print Letters
Use your browser's print dialog to print your finished Letters. Make sure to set "No margins" in your printing dialog to avoid broken dimensions of your document.
### Export PDFs
On macOS you can use your browser's print dialog to export your Letter to PDF via Apple Preview. As long as you get the printing settings correct, the PDF will look good too.
## Setup
### Configuration
You can setup the global content of your Letter in `config/config.php`. Adjust the settings and add your own data there.
#### Available options
```php
return [
'title' => 'Letter',
'dateFormat' => 'd. F Y',
'name' => 'John Doe',
'street' => 'Infinite Loop 12',
'city' => '34512 Examplia',
'country' => 'Germany',
'phone' => '+49 1234 349192',
'mobile' => '+49 0171 12761878',
'email' => '[email protected]',
'website' => 'doe.com',
'bank' => 'GLS',
'iban' => 'DE 1283 1982 9182 91',
'bic' => 'GENODEM1GLS',
'vatId' => 'DE 2128127981729',
'taxId' => '31281/12912',
'closing' => 'All the best,',
'placeholders' => [
'address' => 'Acme Corp.
Sesamestreet 23
12345 Gotham City
USA',
'subject' => 'Subject',
'text' => '
Dear…
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium.
'
],
'labels' => [
'phone' => 'Phone',
'mobile' => 'Mobile',
'email' => 'Email',
'website' => 'Web',
'bank' => 'Bank',
'iban' => 'IBAN',
'bic' => 'BIC',
'vatId' => 'VAT-ID',
'taxId' => 'TAX-ID'
]
];
```
### Custom stylesheet
If you want to adjust Letter's custom styles, go to `config/styles.css` and add your own CSS there. Check out Letter's custom HTML tags in the browser for further information what to adjust.
### Signature
Replace Letter's example signature.png in `config/signature.png` with your own, to load it automatically
### Custom template
If you want to further modify your Letter, you can copy the default template file from `app/template.php` to `config/template.php` to overwrite Letter's default HTML.
## Requirements
- PHP 5.6+
- Latest Chrome or Opera
Firefox and Safari have issues with margins, when you want to print your letter. I haven't tested IE and Edge yet. Help with additional CSS adjustments is highly welcome!
## License
## Author
Bastian Allgeier