mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
9c2293427e
* Made the instructions clearer for people without laravel experience. * Update Install Instructions Updating Instruction to make it clearer * Update README.md * Update README.md Added a word to explain that APP_KEY is user to encrypt data and if you loose it, you won't be able to read your data.
77 lines
3.2 KiB
Markdown
77 lines
3.2 KiB
Markdown
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>
|
|
</p>
|
|
|
|
[](https://travis-ci.org/invoiceninja/invoiceninja)
|
|
[](https://codecov.io/gh/invoiceninja/invoiceninja)
|
|
[](https://www.codacy.com/app/turbo124/invoiceninja?utm_source=github.com&utm_medium=referral&utm_content=invoiceninja/invoiceninja&utm_campaign=Badge_Grade)
|
|
|
|
# Invoice Ninja version 2.0 is coming!
|
|
|
|
We will be using the lessons learnt in Invoice Ninja 4.0 to build a bigger better platform to work from. If you would like to contribute to the project we will gladly accept contributions for code, user guides, bug tracking and feedback! Please consider the following guidelines prior to submitting a pull request:
|
|
|
|
## Quick Start
|
|
|
|
Currently the client portal and API are of alpha quality, to get started:
|
|
|
|
```bash
|
|
git clone https://github.com/invoiceninja/invoiceninja.git
|
|
git checkout v2
|
|
cp .env.example .env
|
|
cp .env.dusk.example .env.dusk.local
|
|
php artisan key:generate
|
|
composer update
|
|
npm i
|
|
npm run production
|
|
```
|
|
|
|
Please Note: Your APP_KEY in the .env file is used to encrypt data, if you loose this you will not be able to run the application.
|
|
|
|
Run if you want to load sample data, remember to configure .env
|
|
```
|
|
php artisan migrate:fresh --seed && php artisan db:seed --class=RandomDataSeeder
|
|
```
|
|
|
|
To Run the web server
|
|
```
|
|
php artisan serve
|
|
```
|
|
|
|
Navigate to (replace ninja.test as required)
|
|
```
|
|
http://ninja.test:8000/setup - To setup your configuration if you didn't load sample data.
|
|
http://ninja.test:8000/ - For Administrator Logon
|
|
http://ninja.test:8000/client/login - For Client Portal
|
|
|
|
user: user@example.com
|
|
pass: password
|
|
```
|
|
|
|
## Contribution guide.
|
|
|
|
Code Style to follow [PSR-2](https://www.php-fig.org/psr/psr-2/) standards.
|
|
|
|
All methods names to be in CamelCase
|
|
|
|
All variables names to be in snake_case
|
|
|
|
Where practical code should be strongly typed, ie your methods must return a type ie
|
|
|
|
`public function doThis() : void`
|
|
|
|
PHP >= 7.3 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following:
|
|
|
|
`public function doThat() ?:string`
|
|
|
|
To improve chances of PRs being merged please include tests to ensure your code works well and integrates with the rest of the project.
|
|
|
|
## Documentation
|
|
|
|
API documentation is hosted using Swagger and can be found [HERE](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja)
|
|
|
|
## Current work in progress
|
|
|
|
Invoice Ninja is currently being written in a combination of Laravel for the API and Client Portal and Flutter for the front end management console. This will allow an immersive and consistent experience across any device: mobile, tablet or desktop.
|
|
|
|
To manage our workflow we will be creating separate branches for the client (Flutter) and server (Laravel API / Client Portal) and merge these into a release branch for deployments.
|