letter

by bastianallgeier

bastianallgeier / letter

Letter is a simple, highly customizable tool to create letters in your browser.

448 Stars 34 Forks Last release: Not found MIT License 28 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Letter

Letter is a simple, highly customizable tool to create letters in your browser.

Letter Screenshot

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

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

http://www.opensource.org/licenses/mit-license.php

Author

Bastian Allgeier
[email protected]
http://twitter.com/bastianallgeier

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.