WikiWorldOrder/BurnerMap

BurnerMap, atop Laravel.

Table of Contents

• Requirements
• Getting Started
• Documentation
• Roadmap
• Change Logs
• Contribution Guidelines
• Reporting a Security Vulnerability

Requirements

• php: >=8.0
• laravel/framework: 9.1.*
• laravel/socialite: 5.5.*

Getting Started

Here are instructions if you are new to Laravel, or just want step-by-step instructions on how to install its development environment, Homestead: SurvLoop.org/how-to-install-laravel-on-a-digital-ocean-server/.

$ composer create-project laravel/laravel burnermap "9.1.*"
$ cd burnermap
% php artisan key:generate
% composer require laravel/socialite components/jquery components/jqueryui

The instructions below include the needed steps to install BurnerMap.

• Install Laravel's default user authentication:

$ php artisan make:auth

• Update composer.json to add a requirement for Socialite, and associate paths for BurnerMap classes:

$ nano composer.json

...
"require": {
	...
    "laravel/socialite": "^4.1.4",
    "rockhopsoft/burnermap": "^1.0",
	...
},
...
"autoload": {
	...
	"psr-4": {
		...
		"RockHopSoft\\BurnerMap\\": "packages/rockhopsoft/burnermap/src/",
	}
	...
},
...
"repositories": {
    {
        "type": "path",
        "url": "./packages/rockhopsoft/burnermap",
        "options": {
            "symlink": true
        }
    }
},
...

$ composer update

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

$ nano config/app.php

...
'providers' => [
	...
	BurnerMap\BurnerMapServiceProvider::class,
	...
],
...
'aliases' => [
	...
	'BurnerMap'	 => 'RockHopSoft\BurnerMap\BurnerMapFacade',
	...
],
...

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

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

• Download packages and copy to these locations in Laravel's public folder...

  • <a href="www.shadowbox-js.com/download.html" target="_blank"

    shadowbox-js.com/download.html Copy the Shadowbox folder to your Laravel directory: public/js/shadowbox-3.0.3

  • github.com/flot/flot Copy flot-master folder to your Laravel directory: public/js/flot-master
  • fonts.google.com/specimen/Oswald Copy folder with TTF files to your Laravel directory: public/css/Oswald

• Change permissions so admins can upload new maps...

$ chown -R www-data:www-data public/images
$ chown -R www-data:www-data public/lib

Documentation

Most of the core BurnerMap action is controlled by /src/Controllers/BurnerMap.php and /src/Views/. The Facebook connection is operated by Laravel's Socialite package, utilized from /src/Controllers/FaceController.php.

More documentation coming soon...

Roadmap

I originally built BurnerMap in 2011, and not a great deal changed outside of the admin tools. In reorganizing the code to release it open source, I primarily just converted it to run atop the Laravel framework. I did lots of code cleanup on the PHP level, and adapted database queries to Laravel's Eloquent, but haven't yet made it to the Javascript, or CSS (which will be worked on alongside a big, overdue UX upgrade). I haven't applied everything I've learned in the past 8 years, but it's lightyears cleaner than it's been!-P

• I expect some more fixes and a few small functionality upgrades this summer.

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 BurnerMap is a secure HTTP app for everyone. If you've discovered a security vulnerability, 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 wikiworldorder at protonmail.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 wikiworldorder at protonmail.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.