index.md

layout	title	nav_order	permalink
default	Getting Started	1	/

![Overview]({{ "/assets/images/overview.png" | absolute_url }})

Laravel-powered Finance Tracker and CRM

{: .fs-9 }

Bookkeeper is a flexible finance tracker and CRM powered by Laravel.
Important: Bookkeeper is still in alpha version and can still receive core changes. Use it at your own risk! {: .fs-6 .fw-300 }

Get started now{: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } View it on GitHub{: .btn .fs-5 }

---

Features (very briefly)

• Responsive and easy-to-use UI
• Finance tracking through an overview, accounts, and tags
• Multiple currency support
• Real-time currency rate updates
• CRM for clients, people, and lists
• Pretty installer and updater

Requirements

Bookkeeper's requirements are the same with Laravel 5.7 (or higher) requirements.

---

Getting Started

Installation

Installing Bookkeeper is fairly simple thanks to it's pretty installer and involves only extracting a ZIP package and creating a database.

![Pretty Installer]({{ "/assets/images/install-1.png" | absolute_url }})

1. Just download the latest release from GitHub and extract the package to your server.
   Since Bookkeeper is structured in the same way of a Laravel application your server's public directory should point to the public directory.
   It is possible to change the setting for the public directory inside the .env file.
2. Create a new MySQL database.
   Bookkeeper will ask for the name, host, port, username, and password for the database during installation.
   ![Database Options]({{ "/assets/images/install-2.png" | absolute_url }})
   For other database drivers you will have to configure the config/database.php, and .env files.
3. Just run the installer by pointing your browser to the root URL of the setup.
   Bookkeeper will do the rest.

---

About the project

Bookkeeper is © 2018 by umΩ.

License

Bookkeeper is distributed by an MIT license.