README

SolidInvoice is a sophisticated open-source invoicing application designed to assist small businesses and freelancers in efficiently managing their daily billing operations. With its comprehensive range of features, this elegant online platform ensures that you receive timely payments.

Key Features

Robust clients and contacts management system
Creation and management of quotes
Generation and oversight of invoices
Seamless online payment acceptance
Effective handling of taxes and discounts
RESTful API for integration with other systems
Receive notifications through various channels, including text messages, emails, or HipChat
Future enhancements planned

Screenshots

System Requirements

SolidInvoice requires PHP version 8.2 or later for optimal performance. It is recommended to use the latest available version of PHP.

Installation Options

Docker

Getting started with SolidInvoice is quick and simple using Docker. The Docker image can be found at https://hub.docker.com/r/solidinvoice/solidinvoice/, along with instructions on how to begin.

Archived Package

To install SolidInvoice from an archived package, download the latest release in either the zip or tar.gz format from https://github.com/SolidInvoice/SolidInvoice/releases. Extract the contents of the archive into the appropriate directory within your web server.

Installation for Developers

If you prefer to install SolidInvoice from the source code, follow these steps:

Clone the repository by executing the following command:

git clone https://github.com/SolidInvoice/SolidInvoice.git

Ensure that you choose a destination path accessible from your web server.

Navigate to the cloned repository:

cd SolidInvoice

Obtain Composer, a dependency management tool, by running:

curl -s http://getcomposer.org/installer | php

Once Composer has finished downloading, install the required dependencies:

php composer.phar install

Install the necessary Node packages and compile all assets with Bun:

bun install
bun run dev

At this point, SolidInvoice should be fully functional.

For production environments, follow these additional steps:

Build the project and optimize it for production:

bun run build

Deploy the optimized version of SolidInvoice.

Contribution Guidelines

For information on contributing to the project, please refer to the CONTRIBUTING file.

License

SolidInvoice is licensed under the MIT license, an open-source software license. For detailed information, please consult the LICENSE file.

Sponsorship

We extend our gratitude to all the sponsors who support this project!

Sponsor @SolidInvoice

Thank you to the following sponsors:

JetBrains (PHPStorm License)
Docker (Docker Hub Subscription)
Sentry (Sponsored Business plan)

solidinvoice / solidinvoice

Maintainers

Details