Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simsustech/slimfact

Streamlined invoicing made easy.
https://github.com/simsustech/slimfact

checkout fastify invoicing quasar-framework trpc typescript vite

Last synced: 20 days ago
JSON representation

Streamlined invoicing made easy.

Awesome Lists containing this project

README

        

# SlimFact

> Streamlined invoicing made easy

SlimFact is a powerful invoicing solution designed to simplify your billing process. Whether you’re a small business owner, freelancer, or enterprise, SlimFact offers seamless invoice management with the following features:

1. Immutable invoices:
- Once an invoice is opened, it remains unchanged. No accidental modifications or discrepancies.
- Fully rendered in the browser, eliminating the need for additional PDF generation packages.

2. Flexible billing:
- For orders that may undergo changes, SlimFact allows you to create bills.
- Bills can be seamlessly converted to receipts once paid, maintaining a clear transaction history.
- If the client requests an invoice, receipts can be converted to an invoice with a single click.

3. Efficient UUID Access:
- Each invoice is uniquely identified by a UUID (Universally Unique Identifier).
- Clients can access their invoices anytime using their unique identifier.

SlimFact streamlines your invoicing process, ensuring accuracy, security, and convenience. Say goodbye to manual paperwork and embrace hassle-free billing with SlimFact! πŸš€πŸ’‘

## Features
- OpenID Connect (OIDC) authentication.
- API can be used headless if desired.
- Ability to use decimals in invoice line quantity.
- Define the tax rate per invoice line and define wether or not the price includes or excludes tax, and automatically calculate the correct amount.
- Send invoices in different languages by defining the locale on invoice level.
- Clients can easily pay their invoices or bills online with the help of a payment service provider.
- Mollie
- Support for multiple [profiles](https://docs.mollie.com/reference/profiles-api).
- Accept down payments.
- Refund payments.
- Support for tracking cash or bank transaction payments.

## Documentation
[Invoice status flowchart](./packages/docs/Flowchart.md)

## Self hosted
You will need a running [Caddy](https://github.com/lucaslorentz/caddy-docker-proxy) container.
```sh
wget https://raw.githubusercontent.com/simsustech/slimfact/main/docker-compose.yaml
wget https://raw.githubusercontent.com/simsustech/slimfact/main/.env.example -O .env
mkdir env
nano -L .env # Change environment
nano -L env/POSTGRES_PASSWORD # Enter postgress password
nano -L env/OTP_SECRET # Enter OTP secret, use openssl rand -base64 32
nano -L env/OIDC_COOKIES_KEYS # Enter OIDC cookies keys, use openssl rand -base64 32, comma separated
docker compose up
```

## Developers
SlimFact is built on top of [Modular API](https://www.simsus.tech/modularapi). You will need an account for private NPM access.

```
git clone https://github.com/simsustech/slimfact.git
cd slimfact
pnpm i
docker compose -f docker-compose.dev.yaml up
cd packages/api
POSTGRES_PASSWORD=ufgouifdgjdfg POSTGRES_DB=slimfact pnpm run migrate:latest
POSTGRES_PASSWORD=ufgouifdgjdfg POSTGRES_DB=slimfact pnpm run seed:fake
pnpm run dev
```

## License
Copyright Β© simsustech 2024-present

[ELv2 License](./LICENSE)