mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-04-07 13:41:23 +00:00
85 lines
2.6 KiB
Markdown
85 lines
2.6 KiB
Markdown
<img src="https://github.com/user-attachments/assets/a6ae2080-e865-4fde-b41d-5a09964d7de2">
|
|
|
|
## Introduction
|
|
|
|
InvoiceShelf is an open-source web & mobile app that helps you track expenses, payments & create professional invoices & estimates.
|
|
|
|
The Web Application is made using Laravel & VueJS while the Mobile Apps are built using React Native.
|
|
|
|
To get started with InvoiceShelf using Docker Compose, check out the [Installation docs](https://docs.invoiceshelf.com/installation.html).
|
|
|
|
# Table of Contents
|
|
|
|
1. [Documentation](#documentation)
|
|
2. [Download](#download)
|
|
3. [Mobile Apps](#mobile-apps)
|
|
4. [Discord - **NEW**](#discord) 🔥
|
|
5. [Roadmap](#roadmap)
|
|
6. [Credits](#credits)
|
|
7. [Help us translate](#translate)
|
|
8. [License](#license)
|
|
|
|
## Documentation
|
|
|
|
- [Installation Steps](https://docs.invoiceshelf.com/installation.html)
|
|
- [User Guide](https://docs.invoiceshelf.com/)
|
|
- [Developer Guide](https://docs.invoiceshelf.com/developer-guide.html)
|
|
- [API Documentation](https://api-docs.invoiceshelf.com)
|
|
|
|
## System Requirements
|
|
|
|
- Starting from **v2.2.0** (Laravel 13 upgrade), InvoiceShelf requires **PHP 8.4+**.
|
|
- Before updating from the app settings, verify your server PHP version and required extensions.
|
|
- The in-app updater checks requirements and blocks the update if they are not met.
|
|
|
|
## Download
|
|
|
|
- [Download Link](https://invoiceshelf.com)
|
|
|
|
## Mobile Apps
|
|
|
|
- Andorid - Coming Soon
|
|
- IOS - Coming Soon
|
|
- [Source](https://github.com/InvoiceShelf/mobile)
|
|
|
|
## Discord
|
|
|
|
Join the InvoiceShelf discord server to discuss:
|
|
[Invite Link](https://discord.gg/eHXf4zWhsR)
|
|
|
|
## Roadmap
|
|
|
|
~~Here's a rough roadmap of things to come (not in any specific order):
|
|
|
|
- [x] Automatic Update
|
|
- [x] Email Configuration
|
|
- [x] Installation Wizard
|
|
- [x] Address Customisation & Default notes
|
|
- [x] Edit Email before Sending Invoice
|
|
- [x] Available as a docker image
|
|
- [x] Performance Improvements
|
|
- [x] Customer View page
|
|
- [x] Add and Use Custom Fields on Invoices & Estimates.
|
|
- [x] Multiple Companies
|
|
- [x] Recurring Invoices
|
|
- [x] Customer Portal
|
|
- [ ] Accept Payments (Stripe Integration)
|
|
- [ ] Improved template system (invoices and estimate)
|
|
- [ ] Modules and templates marketplace
|
|
|
|
## Credits
|
|
|
|
InvoiceShelf is made possible thanks to the contributions and support from many people and projects:
|
|
|
|
- [Crater](https://github.com/crater-invoice-inc/crater) (project inspiration and code base)
|
|
- All contributors who have provided code, translations, reported issues, or supported the project in any way.
|
|
|
|
## Translate
|
|
|
|
Help us translate on https://crowdin.com/project/invoiceshelf
|
|
|
|
## License
|
|
|
|
InvoiceShelf is released under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3.
|
|
See [LICENSE](LICENSE) for details.
|