David Bomba
GitHub
commit
5a0a09aef9
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Invoice Ninja Code of Conduct
|
||||||
|
|
||||||
|
The development team has invested a tremendous amount of time and energy into this project. While we appreciate that bugs can be frustrating we ask that our community refrain from insults and snide remarks. We're happy to provide support to both our hosted and selfhosted communities but ask that feedback is always polite.
|
||||||
|
|
@ -0,0 +1,119 @@
|
||||||
|
# Contributing to CONTRIBUTING.md
|
||||||
|
|
||||||
|
First off, thanks for taking the time to contribute!
|
||||||
|
|
||||||
|
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
|
||||||
|
|
||||||
|
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
|
||||||
|
> - Star the project
|
||||||
|
> - Tweet about it
|
||||||
|
> - Refer this project in your project's readme
|
||||||
|
> - Mention the project at local meetups and tell your friends/colleagues
|
||||||
|
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Code of Conduct](#code-of-conduct)
|
||||||
|
- [I Have a Question](#i-have-a-question)
|
||||||
|
- [I Want To Contribute](#i-want-to-contribute)
|
||||||
|
- [Reporting Bugs](#reporting-bugs)
|
||||||
|
- [Suggesting Enhancements](#suggesting-enhancements)
|
||||||
|
- [Your First Code Contribution](#your-first-code-contribution)
|
||||||
|
- [Improving The Documentation](#improving-the-documentation)
|
||||||
|
- [Styleguides](#styleguides)
|
||||||
|
- [Commit Messages](#commit-messages)
|
||||||
|
- [Join The Project Team](#join-the-project-team)
|
||||||
|
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
This project and everyone participating in it is governed by the
|
||||||
|
[CONTRIBUTING.md Code of Conduct](blob/v5-stable/CODE_OF_CONDUCT.md).
|
||||||
|
By participating, you are expected to uphold this code. Please report unacceptable behavior
|
||||||
|
to <>.
|
||||||
|
|
||||||
|
|
||||||
|
## I Have a Question
|
||||||
|
|
||||||
|
> If you want to ask a question, we assume that you have read the available [Documentation](https://invoiceninja.github.io), Searched the [Forum](https://forum.invoiceninja.com), or tried chatting with us on [Slack](https://invoiceninja.slack.com) [generate a slack invite here](http://slack.invoiceninja.com)
|
||||||
|
|
||||||
|
Please reserve issues for bugs, general questions posted in the issues section will be closed and redirected to other support venues.
|
||||||
|
|
||||||
|
## I Want To Contribute
|
||||||
|
|
||||||
|
|
||||||
|
> ### Legal Notice
|
||||||
|
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. Please note that you'll need to sign the CLA for any PRs to be accepted
|
||||||
|
|
||||||
|
### Reporting Bugs
|
||||||
|
|
||||||
|
|
||||||
|
#### Before Submitting a Bug Report
|
||||||
|
|
||||||
|
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
|
||||||
|
|
||||||
|
- Make sure that you are using the latest version.
|
||||||
|
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://invoiceninja.github.io). If you are looking for support, you might want to check [this section](#i-have-a-question)).
|
||||||
|
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug).
|
||||||
|
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
|
||||||
|
- Collect information about the bug:
|
||||||
|
- Stack trace (Traceback)
|
||||||
|
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
|
||||||
|
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
|
||||||
|
- Possibly your input and the output
|
||||||
|
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
|
||||||
|
|
||||||
|
|
||||||
|
#### How Do I Submit a Good Bug Report?
|
||||||
|
|
||||||
|
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <contact@invoiceninja.com>.
|
||||||
|
|
||||||
|
|
||||||
|
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
|
||||||
|
|
||||||
|
- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
|
||||||
|
- Explain the behavior you would expect and the actual behavior.
|
||||||
|
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
|
||||||
|
- Provide the information you collected in the previous section.
|
||||||
|
|
||||||
|
Once it's filed:
|
||||||
|
|
||||||
|
- The project team will label the issue accordingly.
|
||||||
|
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
|
||||||
|
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Suggesting Enhancements
|
||||||
|
|
||||||
|
This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
|
||||||
|
|
||||||
|
|
||||||
|
#### Before Submitting an Enhancement
|
||||||
|
|
||||||
|
- Make sure that you are using the latest version.
|
||||||
|
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
|
||||||
|
- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
|
||||||
|
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
|
||||||
|
|
||||||
|
|
||||||
|
#### How Do I Submit a Good Enhancement Suggestion?
|
||||||
|
|
||||||
|
Enhancement suggestions are tracked as [GitHub issues](/issues).
|
||||||
|
|
||||||
|
- Use a **clear and descriptive title** for the issue to identify the suggestion.
|
||||||
|
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
|
||||||
|
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
|
||||||
|
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
|
||||||
|
- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Your First Code Contribution
|
||||||
|
|
||||||
|
All PRs should be created against the v5-develop branch.
|
||||||
|
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!
|
||||||
|
|
@ -0,0 +1,182 @@
|
||||||
|
<p align="center">
|
||||||
|
<a href ="https://www.youtube.com/watch?v=CxGxXiotv0I" target="_blank" title="Invoice Ninja Overview Video"><img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
[](https://www.codacy.com/gh/turbo124/invoiceninja/dashboard?utm_source=github.com&utm_medium=referral&utm_content=turbo124/invoiceninja&utm_campaign=Badge_Grade)
|
||||||
|
<a href="https://cla-assistant.io/invoiceninja/invoiceninja"><img src="https://cla-assistant.io/readme/badge/invoiceninja/invoiceninja" alt="CLA assistant" /></a>
|
||||||
|
|
||||||
|
# Invoice Ninja 5
|
||||||
|
|
||||||
|
Invoice Ninja Version 5 is here! We've taken the best parts of version 4 and added the most requested features to create an invoicing application like no other. Check the [Invoice Ninja YouTube Channel](https://www.youtube.com/@appinvoiceninja) to get up to speed, or try the [Demo](https://react.invoicing.co/demo) now.
|
||||||
|
|
||||||
|
**Choose your setup**
|
||||||
|
|
||||||
|
- [Hosted](https://www.invoiceninja.com): Our hosted version is a Software as a Service (SaaS) solution. You're up and running in under 5 minutes, with no need to worry about hosting or server infrastructure.
|
||||||
|
- [Self-Hosted](https://www.invoiceninja.org): For those who prefer to manage their own hosting and server infrastructure. This version gives you full control and flexibility.
|
||||||
|
|
||||||
|
All Pro and Enterprise features from the hosted app are included in the source-available code. We offer a $30 per year white-label license to remove the Invoice Ninja branding from client-facing parts of the app.
|
||||||
|
|
||||||
|
#### Get social with us
|
||||||
|
|
||||||
|
* [Support Forum](https://forum.invoiceninja.com)
|
||||||
|
* [Slack](http://slack.invoiceninja.com)
|
||||||
|
* [Discord](https://discord.gg/ZwEdtfCwXA)
|
||||||
|
* [Instagram](https://www.instagram.com/appinvoiceninja)
|
||||||
|
|
||||||
|
#### Documentation
|
||||||
|
|
||||||
|
* [Invoice Ninja - API](https://api-docs.invoicing.co/)
|
||||||
|
* [Invoice Ninja - Developer Guide](https://invoiceninja.github.io/en/developer-guide/)
|
||||||
|
* [Invoice Ninja - User Guide](https://invoiceninja.github.io/en/user-guide/)
|
||||||
|
* [Invoice Ninja - Self-Hosted Installation Guide](https://invoiceninja.github.io/en/self-host-installation/)
|
||||||
|
|
||||||
|
## Installation Options and Clients
|
||||||
|
|
||||||
|
### Mobile Apps
|
||||||
|
* [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone)
|
||||||
|
* [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
|
||||||
|
* [F-Droid](https://f-droid.org/en/packages/com.invoiceninja.app)
|
||||||
|
|
||||||
|
### Desktop Apps
|
||||||
|
* [macOS](https://apps.apple.com/app/id1503970375?platform=mac)
|
||||||
|
* [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6)
|
||||||
|
* [Linux - Snap](https://snapcraft.io/invoiceninja)
|
||||||
|
* [Linux - Flatpak](https://flathub.org/apps/com.invoiceninja.InvoiceNinja)
|
||||||
|
|
||||||
|
### Self-Hosted Server Installation
|
||||||
|
**Note:** The self-hosted options do support the desktop and mobile apps.
|
||||||
|
|
||||||
|
* [Server or VM](https://invoiceninja.github.io/en/self-host-installation/)
|
||||||
|
* [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/)
|
||||||
|
* [Cloudron](https://www.cloudron.io/store/com.invoiceninja.cloudronapp2.html)
|
||||||
|
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
|
||||||
|
* [Elestio](https://elest.io/open-source/invoiceninja)
|
||||||
|
* [YunoHost](https://apps.yunohost.org/app/invoiceninja5)
|
||||||
|
|
||||||
|
### Recommended Providers
|
||||||
|
* [Stripe](https://stripe.com/)
|
||||||
|
* [Postmark](https://postmarkapp.com/)
|
||||||
|
|
||||||
|
## [Advanced] Quick Hosting Setup
|
||||||
|
|
||||||
|
In addition to the official [Invoice Ninja - Self-Hosted Installation Guide](https://invoiceninja.github.io/en/self-host-installation/) we have a few commands for you.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone --depth 1 -b v5.11.53 https://github.com/invoiceninja/invoiceninja.git
|
||||||
|
cp .env.example .env
|
||||||
|
composer i -o --no-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note** replace v5.11.53 with the latest tag version, you will also want to ensure that when performing updates, you use the latest tag version rather than a particular branch, ie v5-develop. This will ensure that you are not pulling in work in progress code.
|
||||||
|
|
||||||
|
Please Note:
|
||||||
|
Your APP_KEY in the .env file is used to encrypt data, if you lose this you will not be able to run the application.
|
||||||
|
|
||||||
|
Run if you want to load sample data, remember to configure .env
|
||||||
|
```sh
|
||||||
|
php artisan migrate:fresh --seed && php artisan db:seed && php artisan ninja:create-test-data
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the web server
|
||||||
|
```sh
|
||||||
|
php artisan serve
|
||||||
|
```
|
||||||
|
|
||||||
|
Navigate to (replace localhost with the appropriate domain)
|
||||||
|
```
|
||||||
|
http://localhost:8000/setup - To setup your configuration if you did not load sample data.
|
||||||
|
http://localhost:8000/ - For Administrator Logon
|
||||||
|
|
||||||
|
user: small@example.com
|
||||||
|
pass: password
|
||||||
|
|
||||||
|
http://localhost:8000/client/login - For Client Portal
|
||||||
|
|
||||||
|
user: user@example.com
|
||||||
|
pass: password
|
||||||
|
```
|
||||||
|
## Developers Guide
|
||||||
|
|
||||||
|
In addition to the official [Invoice Ninja - Developer Guide](https://invoiceninja.github.io/en/developer-guide/) we've got your back with some insights.
|
||||||
|
|
||||||
|
### App Design
|
||||||
|
|
||||||
|
The API and client portal have been developed using [Laravel](https://laravel.com) if you wish to contribute to this project familiarity with Laravel is essential.
|
||||||
|
|
||||||
|
When inspecting functionality of the API, the best place to start would be in the routes/api.php file which describes all of the availabe API endpoints. The controller methods then describe all the entry points into each domain of the application, ie InvoiceController / QuoteController
|
||||||
|
|
||||||
|
The average API request follows this path into the application.
|
||||||
|
|
||||||
|
* Middleware processes the request initially inspecting the domain being requested + provides the authentication layer.
|
||||||
|
* The request then passes into a Form Request (Type hinted in the controller methods) which is used to provide authorization and also validation of the request. If successful, the request is then passed into the controller method where it is digested, here is an example:
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function store(StoreInvoiceRequest $request)
|
||||||
|
{
|
||||||
|
|
||||||
|
$invoice = $this->invoice_repo->save($request->all(), InvoiceFactory::create(auth()->user()->company()->id, auth()->user()->id));
|
||||||
|
|
||||||
|
$invoice = $invoice->service()
|
||||||
|
->fillDefaults()
|
||||||
|
->triggeredActions($request)
|
||||||
|
->adjustInventory()
|
||||||
|
->save();
|
||||||
|
|
||||||
|
event(new InvoiceWasCreated($invoice, $invoice->company, Ninja::eventVars(auth()->user() ? auth()->user()->id : null)));
|
||||||
|
|
||||||
|
return $this->itemResponse($invoice);
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Here for example we are storing a new invoice, we pass the validated request along with a factory into the invoice repository where it is processed and saved.
|
||||||
|
|
||||||
|
The returned invoice then passes through its service class (app/Services/Invoice) where various actions are performed.
|
||||||
|
|
||||||
|
A event is then fired which notifies listeners in the application (app/Providers/EventServiceProvider) which perform non blocking sub tasks
|
||||||
|
|
||||||
|
Finally the invoice is transformed (app/Transformers/) and returned as a response via Fractal.
|
||||||
|
|
||||||
|
### Developer environment
|
||||||
|
|
||||||
|
Using the Quick Hosting Setup describe above you can quickly get started building out your development environment. Instead of using
|
||||||
|
|
||||||
|
```
|
||||||
|
composer i -o --no-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
use
|
||||||
|
|
||||||
|
```
|
||||||
|
composer i -o
|
||||||
|
```
|
||||||
|
|
||||||
|
This provides the developer tools including phpunit which allows the test suite to be run.
|
||||||
|
|
||||||
|
If you are considering contributing back to the main repository, please add in any tests for new functionality / modifications. This will greatly increase the chances of your PR being accepted
|
||||||
|
|
||||||
|
Also, if you plan any additions for the main repository, you may want to discuss this with us first on Slack where we can assist with any technical information and provide advice.
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
* [Hillel Coren](https://hillelcoren.com/)
|
||||||
|
* [David Bomba](https://github.com/turbo124)
|
||||||
|
* [Benjamin Beganović](https://github.com/beganovich)
|
||||||
|
* [All Contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors)
|
||||||
|
|
||||||
|
|
||||||
|
## Want More?
|
||||||
|
Checkout our other projects here!
|
||||||
|
|
||||||
|
[Event Schedule](https://www.eventschedule.com/)
|
||||||
|
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
If you find a security issue with this application, please send an email to contact@invoiceninja.com.
|
||||||
|
Please follow responsible disclosure procedures if you detect an issue.
|
||||||
|
For further information on responsible disclosure please read [here](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html).
|
||||||
|
|
||||||
|
## License
|
||||||
|
Invoice Ninja is released under the Elastic License.
|
||||||
|
See [LICENSE](LICENSE) for details.
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
## Security
|
||||||
|
|
||||||
|
If you find a security issue with this application, please send an email to contact@invoiceninja.com.
|
||||||
|
Please follow responsible disclosure procedures if you detect an issue.
|
||||||
|
For further information on responsible disclosure please read [here](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html).
|
||||||
Loading…
Reference in New Issue