Resource Contracts
JavaScript PHP HTML Java CSS Shell
Switch branches/tags
Clone or download
iprunache #1082 Use latest remote_syslog version
Watch a single app log file instead of all the timestamped logs.
Latest commit 67bd23b Dec 20, 2017
Permalink
Failed to load latest commit information.
.ebextensions issue 90 Jun 25, 2015
app #1082 Only wathc laravel.log Dec 19, 2017
bootstrap * activity logging Jun 18, 2015
conf #1082 Use latest remote_syslog version Dec 20, 2017
config [1038] Transfer of risk category deleted from codelist Mar 3, 2017
database initial work Mar 28, 2017
public contract review undefiened Translation lang Apr 6, 2017
resources contract review undefiened Translation lang Apr 6, 2017
storage scoping-user-permissions Apr 29, 2016
tests displaying associated documents in admin site Feb 29, 2016
.codeclimate.yml added config for codeclimate.com Jun 12, 2015
.dockerignore Optimized dockerfile Dec 23, 2016
.env.example view react js code compressed and minified Sep 13, 2016
.gitattributes added gitignore file Jun 1, 2015
.gitignore [1038] Transfer of risk category deleted from codelist Mar 3, 2017
Dockerfile #1082 Use latest remote_syslog version Dec 20, 2017
LICENSE Initial commit May 27, 2015
LICENSE.md email address changed in licnse page Feb 16, 2016
artisan * added Laravel Framework files Jun 2, 2015
composer.json Tests integrated within admin Jan 14, 2016
composer.lock New Annotation Module [WIP] Apr 28, 2016
create_version.sh #157 Added create version. Dec 29, 2016
docker-readme.md Add original Dockerfile and dependencies Dec 20, 2016
gulpfile.js initial work Mar 28, 2017
issue_template.md Added issue_template.md Nov 14, 2017
package.json view react js code compressed and minified Sep 13, 2016
phpspec.yml * added Laravel Framework files Jun 2, 2015
phpunit.xml NRGI-2 Connecting with Shippable for tests Jun 3, 2015
readme.md [x] fixed error on downloading doc Jul 14, 2016
server.php * added Laravel Framework files Jun 2, 2015
shippable-deploy.sh #157 Added create version. Dec 29, 2016
shippable.yml 1081 Removed -f flag. No longer supported by docker Nov 15, 2017

readme.md

NRGI

Scrutinizer Code Quality

Install

NRGI can be cloned from github repository and installed. Following the procedure given below:

Run

The app can be run with the command below:

  • install the application dependencies using command: composer install
  • copy .env.example to .env and update your the database configurations
  • give write permission to the storage folder using chmod -R 777 storage
  • run migration using php artisan migrate
  • seed dummy data using php artisan db:seed
  • make a directory uploads inside public and give write permission to it
  • access http://resourcecontracts.dev

Framework

The application is written in PHP based on the Laravel framework, current version of Laravel used for this project is 5.

Tools and packages

This application uses many tools and packages, the packages can be seen in the composer.json file and javascript packages are listed in the package.json file.

Some major PHP packages used are listed below:

Structure

The application is structured in a very simple way in app\Nrgi folder.

Nrgi folder contains other 3 folders

  • Repositories: Contains all the classes for storage and retrival from database.
  • Entities: Contains all the eloquent model classes.
  • Services: Contains the classes which serves as the intermediate for Controllers and Repositories. All the application logic are handled here. Logger is also implemented inside services. The purpose of using services is to keep our controllers slim.

Classes inside each of the above directories are properly written within corresponding modules namespace.

Check code quality

We follow PSR-2 for coding standard

Coding Conventions

We follow PSR-2

Tests

For this project we use php unit tests using PHPUnit framework integrated with Shippable CI.

phpunit or ./bin/vendor/phpunit

Deployment

We use Elastic Beanstalk CLI.

Support

For any queries and support, you may either create a github issue or send us an email at resourcecontracts@yipl.com.np

Copyright and license

Code copyright Natural Resource Governance Institute. Code released under the MIT license