https://github.com/invoiceplane/.github
https://github.com/invoiceplane/.github
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/invoiceplane/.github
- Owner: InvoicePlane
- Created: 2025-02-05T06:18:00.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-07T18:19:45.000Z (over 1 year ago)
- Last Synced: 2025-10-07T05:40:37.316Z (9 months ago)
- Size: 16.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# InvoicePlane
InvoicePlane is a self-hosted, open-source application designed to help you manage invoices, clients, and payments efficiently.
## Key Features
- **Invoice & Quote Management:** Create, send, and manage professional invoices and quotes effortlessly.
- **Client Management:** Maintain detailed client records, including contact information and transaction history.
- **Payment Tracking:** Monitor payments, set up reminders, and integrate with multiple payment gateways.
- **Customization:** Tailor templates, themes, and settings to match your brand preferences.
- **Reporting:** Generate insightful reports to track your financial performance.
---
## Getting Started
To get started with InvoicePlane:
1. **Download the Latest Version:**
- Visit the [InvoicePlane website](https://www.invoiceplane.com/) to download the latest release.
2. **Extract and Upload:**
- Extract the downloaded package and upload the files to your web server or hosting environment.
3. **Configuration:**
- Duplicate `ipconfig.php.example` and rename it to `ipconfig.php`.
- Open `ipconfig.php` in a text editor and set your base URL.
4. **Run the Installer:**
- Navigate to `http://your-domain.com/index.php/setup` in your browser and follow the on-screen instructions to complete the installation.
For a **detailed installation guide**, including prerequisites and troubleshooting tips, refer to [INSTALLATION.md](INSTALLATION.md).
---
## Removing `index.php` from URLs (Optional)
To remove `index.php` from your URLs:
1. **Enable mod_rewrite:**
- Ensure the `mod_rewrite` module is enabled on your web server.
2. **Update Configuration:**
- Set `REMOVE_INDEXPHP` to `true` in your `ipconfig.php` file.
3. **Rename `.htaccess`:**
- Rename the `htaccess` file in the root directory to `.htaccess`.
> **Note:** If you experience issues after making these changes, revert to the default settings by undoing the steps above.
---
## Community and Support
Join our vibrant community for support, discussions, and contributions:
- **Community Forums:** [InvoicePlane Forums](https://community.invoiceplane.com/) - Ask questions, share knowledge, and get help from the community.
- **Discord:** [Join our Discord](https://discord.gg/PPzD2hTrXt) - Chat with users, developers, and contributors in real time.
- **Issue Tracker:** [GitHub Issues](https://github.com/InvoicePlane/InvoicePlane/issues) - Report bugs and request features.
- **Wiki & Documentation:** [InvoicePlane Wiki](https://wiki.invoiceplane.com/) - Find guides, FAQs, and detailed setup instructions.
> *InvoicePlane is developed and maintained by a dedicated team of volunteers. Support is provided by the community on a best-effort basis.*
---
## Contributing
We welcome contributions from the community! To get involved:
- **Report Issues:** Use the [Issue Tracker](https://github.com/InvoicePlane/InvoicePlane/issues) to report bugs or request features.
- **Submit Pull Requests:** Fork the repository, make your changes, and submit a pull request for review.
- **Translate InvoicePlane:** Help translate the application into your language. Also see [Translations.md](TRANSLATIONS.md)
For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
---
## Security Vulnerabilities
If you discover a security vulnerability, please email **[mail@invoiceplane.com](mailto:mail@invoiceplane.com)** before disclosing it publicly. We will address all security concerns promptly.
---
## License & Copyright
InvoicePlane is licensed under the [MIT License](LICENSE.txt).
The **InvoicePlane name** and **logo** are copyrighted by [Kovah.de](https://kovah.de/) and [InvoicePlane.com](https://www.invoiceplane.com/). Usage is restricted. For more information, visit [license & copyright](https://www.invoiceplane.com/license-copyright).