Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
<img alt="Self-hosted" src="https://img.shields.io/badge/cloud-not%20required-16a34a">
</p>

![Folio dashboard showing cash flow, outstanding balances and recent invoices](./docs/screenshots/dashboard.png)

## What Folio does

- Creates drafts and searchable A4 PDF invoices in multiple currencies. Published invoices, including paid and void invoices, can be edited after acknowledging a warning. Previous versions and PDFs remain available in the edit history; edits update the existing invoice and reports. Recorded payments keep their original amounts and currencies.
Expand All @@ -32,6 +34,29 @@

Customer address maps use a Google Maps iframe and need no API key. Folio makes no map requests until the viewer chooses **Allow once** or **Always allow**. Loading a map shares the billing address and the viewer's IP address with Google, which may also use cookies. **Allow once** lasts for the current page visit; **Always allow** is saved in this browser for all customer maps on this Folio installation. Customers without address details beyond a country do not show a map.

## Screenshots

<details>
<summary><strong>Invoices: preview the document, track payments and download a PDF</strong></summary>

![Invoice workspace with a document preview, billing details, tax totals and payment status](./docs/screenshots/invoice.png)

</details>

<details>
<summary><strong>Customers: billing details and a complete invoice history</strong></summary>

![Customer workspace showing paid, part-paid and overdue invoices alongside contact details and an address map](./docs/screenshots/customer.png)

</details>

<details>
<summary><strong>Reports: sales, cash flow and expenses by category</strong></summary>

![Reports showing invoice sales, payments received, monthly cash flow and an expense breakdown](./docs/screenshots/reports.png)

</details>

## Run with Docker Compose

Create `compose.yaml`:
Expand Down
Binary file added docs/screenshots/customer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/invoice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/reports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.