MDC Panel

The following web-application is a hub for multi-functional tools, maps, resources, and generators and was purpose-built for processing and easing official government paperwork.

Features

• Simple and fast form fill-out process for reports, threads, general paperwork.
• Dynamic site elements. (Live clock, Breadcrumb, Day & Night Mode)
• Cookies saving user details upon submission. (Officer Name, Rank, Badge, Call Signs)
• Dynamic input fields, slots, and forms.
• Automatic HTML code or BBCode generation.
• Friendly copy and paste procedure.

Getting Started

These instructions will explain on how to obtain a working copy of the project up and running onto your local machine.

See the Deployment section for further instructions on how to setup the project after going through the Prerequisites & Requirements section.

Prerequisites & Requirements

Web-development platforms (such as WAMP, XAMP) which include the following software is required in order to run the project on a local machine.

Apache2
PHP 7+

Deployment

The following steps will, in brief, explain how to setup your project up and running onto your local machine for development and testing purposes.

1. Local Respository

Download the project repository to your local machine under any development path. e.g. X:/Your/Path/To/MDC

2. Virtual Hosts

Using your web-development platform of choice, create a new VirtualHost. This is usually the httpd-vhosts.conf file, however, filenames may vary on development platform basis and therefore you should research on how to accesss such a file if not knowledgable in this area.

<VirtualHost *:80>
	ServerName MDC
	DocumentRoot "X:/Your/Path/To/MDC"
	<Directory  "X:/Your/Path/To/MDC/">
		Options +Indexes +Includes +FollowSymLinks +MultiViews
		AllowOverride All
		Require local
	</Directory>
</VirtualHost>

3. Local Machine Hosts File

Access your machine's hosts file to override the Domain Name System (DNS) for a local machine domain to gain easier access to the website.

Windows

• Open Command Prompt with Administrator Privileges
• Enter the following: notepad C:\Windows\System32\drivers\etc\hosts

Linux

• Open Terminal
• Enter the following: sudo nano /etc/hosts

Add the following line at the bottom of the hosts file: 127.0.0.1 panel.local Save the hosts file.

4. Create a visitors database

Locate the `db` folder within your MDC Panel repository and create an empty json file with the name `visitors.json`.

This is important as otherwise the website will not load properly!

5. Local Website Access

Turn on your web-development platform and access the local website for development/testing purposes.

http://panel.local

Built With

• Bootstrap - Web Framework
• FontAwesome - Font Icon Toolkit
• Leaflet - Web Mapping Application

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Contributors

• CXDezign - Creator & Founder - CXDezign
• Biscuit - Developer & Project Manager - Biscuit
• aeromantis - Developer - aeromantis
• Skent - Initial Arrest Report, Patrol Log, and Impound Report Generators - Skenticus
• Cascade - Base Leaflet code - Cascadee88
• Spartan - Constant suggestions and interest in the project.
• Wedged - Constant suggestions and interest in the project.
• Brett - Original Penal Code creator and maintainer.

Donations

I am not accepting donations for this project, you can help by contributing to the project or by donating to either the original creator CXDezign and/or by donating to GTA:W.