GreenBConsulting/KindGuide

Green B presents The Kind Guide database, a web app empowering the cannabis community and the industry to track growth in ever more sustainable directions. The site helps collect data and information to inform this pollination. The Kind Guide database is built using SurvLoop, atop Laravel. http://GoGreenB.org SurvLoop is a Laravel-based engine for designing a database and creating a mobile-friendly user interface to fill it.

Table of Contents

• Requirements
• Getting Started
• Documentation
• Roadmap
• Change Logs
• Contribution Guidelines

Requirements

• php: >=7.2.11
• laravel/framework: 5.7.*
• rockhopsoft/survloop: 0.*

Getting Started

The instructions below include the needed steps to install Laravel, SurvLoop, as well as the Kind Guide system. For more on creating environments to host Laravel, you can find more instructions on SurvLoop.org.

• Use Composer to install Laravel with default user authentication, one required package:

$ composer global require "laravel/installer"
$ composer create-project laravel/laravel KindGuide "5.7.*"
$ cd KindGuide
$ php artisan make:auth
$ php artisan vendor:publish --tag=laravel-notifications

• Update composer.json to add requirements and an easier Kind Guide reference:

$ nano composer.json

...
"require": {
	...
    "greenbconsulting/kindguide": "0.*",
	...
},
...
"autoload": {
	...
	"psr-4": {
		...
		"KindGuide\\": "vendor/greenbconsulting/kindguide/src/",
	}
	...
},
...

$ composer update

• Add the package to your application service providers in config/app.php.

$ nano config/app.php

...
'providers' => [
	...
	SurvLoop\SurvLoopServiceProvider::class,
	KindGuide\KindGuideServiceProvider::class,
	...
],
...
'aliases' => [
	...
	'SurvLoop'	 => 'RockHopSoft\SurvLoop\SurvLoopFacade',
	'KindGuide'	 => 'GreenBConsulting\KindGuide\KindGuideFacade',
	...
],
...

• Swap out the SurvLoop user model in config/auth.php.

$ nano config/auth.php

...
'model' => App\Models\User::class,
...

• Update composer, publish the package migrations, etc...

$ php artisan vendor:publish --force
$ php artisan migrate
$ composer dump-autoload
$ php artisan db:seed --class=SurvLoopSeeder
$ php artisan db:seed --class=KindGuideSeeder

• For now, to apply database design changes to the same installation you are working in, depending on your server, you might also need something like this...

$ chown -R www-data:33 app/Models
$ chown -R www-data:33 database

• Browse to load the style sheets, etc.. /dashboard/css-reload

• Log into The Kind Guide admin dashboard...

user: open@thekind.guide
password: KindGuide

Documentation

Once installed, documentation of this system's database design can be found at /dashboard/db/all . This system's user experience design for data entry can be found at /dashboard/tree/map?all=1&alt=1 .

Roadmap

Here's the TODO list for the next release (1.0). It's my first time building on Laravel, or GitHub. So sorry.

• [ ] Code commenting, learning and implementing more community standards.
• [ ] Correct collection of issues still on my list.
• [ ] Adding unit testing.
• [ ] Basic database design and user experience processes are generated by SurvLoop itself.
• [ ] Finish migrating all queries to use Laravel's process.

Change Logs

Contribution Guidelines

Please help educate me on best practices for sharing code in this community. Please report any issue you find in the issues page.

Reporting a Security Vulnerability

We want to ensure that SurvLoop is a secure HTTP open data platform for everyone. If you've discovered a security vulnerability at App.TheKind.Guide, we appreciate your help in disclosing it to us in a responsible manner.

Publicly disclosing a vulnerability can put the entire community at risk. If you've discovered a security concern, please email us at rockhoppers at runbox.com. We'll work with you to make sure that we understand the scope of the issue, and that we fully address your concern. We consider correspondence sent to rockhoppers at runbox.com our highest priority, and work to address any issues that arise as quickly as possible.

After a security vulnerability has been corrected, a release will be deployed as soon as possible.