Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-08-11 15:34:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

Made the instructions clearer (#3601)

Browse Source 
* 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.
This commit is contained in:
IntegrateIT 2020-04-07 21:46:53 +01:00 committed by GitHub
parent 6a0ddd6c38
commit 9c2293427e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 78 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -25,3 +25,5 @@ local_version.txt
# Ignore local migrations # Ignore local migrations
storage/migrations storage/migrations
nbproject
/composer.lock

137
README.md
View File

@ -1,61 +1,76 @@
<p align="center"> <p align="center">
<img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/> <img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>
</p> </p>
[![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=v2)](https://travis-ci.org/invoiceninja/invoiceninja) [![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=v2)](https://travis-ci.org/invoiceninja/invoiceninja)
[![codecov](https://codecov.io/gh/invoiceninja/invoiceninja/branch/v2/graph/badge.svg)](https://codecov.io/gh/invoiceninja/invoiceninja) [![codecov](https://codecov.io/gh/invoiceninja/invoiceninja/branch/v2/graph/badge.svg)](https://codecov.io/gh/invoiceninja/invoiceninja)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d39acb4bf0f74a0698dc77f382769ba5)](https://www.codacy.com/app/turbo124/invoiceninja?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=invoiceninja/invoiceninja&amp;utm_campaign=Badge_Grade) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d39acb4bf0f74a0698dc77f382769ba5)](https://www.codacy.com/app/turbo124/invoiceninja?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=invoiceninja/invoiceninja&amp;utm_campaign=Badge_Grade)
# Invoice Ninja version 2.0 is coming! # 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: 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 ## Quick Start
Currently the client portal and API are of alpha quality, to get started: Currently the client portal and API are of alpha quality, to get started:
```bash ```bash
git clone https://github.com/invoiceninja/invoiceninja.git git clone https://github.com/invoiceninja/invoiceninja.git
git checkout v2 git checkout v2
cp .env.example .env cp .env.example .env
cp .env.dusk.example .env.dusk.local cp .env.dusk.example .env.dusk.local
composer update php artisan key:generate
npm i composer update
npm run production npm i
php artisan migrate:fresh --seed && php artisan db:seed --class=RandomDataSeeder npm run production
``` ```
Navigate to 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.
```
http://ninja.test:8000/client/login Run if you want to load sample data, remember to configure .env
user: user@example.com ```
pass: password php artisan migrate:fresh --seed && php artisan db:seed --class=RandomDataSeeder
``` ```
## Contribution guide. To Run the web server
```
Code Style to follow [PSR-2](https://www.php-fig.org/psr/psr-2/) standards. php artisan serve
```
All methods names to be in CamelCase
Navigate to (replace ninja.test as required)
All variables names to be in snake_case ```
http://ninja.test:8000/setup - To setup your configuration if you didn't load sample data.
Where practical code should be strongly typed, ie your methods must return a type ie http://ninja.test:8000/ - For Administrator Logon
http://ninja.test:8000/client/login - For Client Portal
`public function doThis() : void`
user: user@example.com
PHP >= 7.3 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following: pass: password
```
`public function doThat() ?:string`
## Contribution guide.
To improve chances of PRs being merged please include tests to ensure your code works well and integrates with the rest of the project.
Code Style to follow [PSR-2](https://www.php-fig.org/psr/psr-2/) standards.
## Documentation
All methods names to be in CamelCase
API documentation is hosted using Swagger and can be found [HERE](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja)
All variables names to be in snake_case
## Current work in progress
Where practical code should be strongly typed, ie your methods must return a type ie
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.
`public function doThis() : void`
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.
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.