📰 CodeJuan

This is a project done using Laravel 5.2 PHP framework. This covers basics of the framework. Laravel 5.2 is full-stack modern PHP framework, that used all new features introduced in recent PHP versions.

Setup Instructions

Deployment Requirements:

Composer 2.0.XX
XAMPP 5.6 or newer or WampServer 3.2.X
Visual Studio Code
Git

Installation

Option 1: Unzip and Copy Team-A-Codeniverse folder onto your xampp\htdocs or wamp64\www folder.
Option 2: Clone the repository by running this command:

> git clone https://github.com/Blue-Hacks-2021/Team-A-Codeniverse.git

After cloning run following command to download the dependencies and generate env file and app key:

> composer install
> cp .env.example .env
> php artisan key:generate

Find the .env file and edit following fields:

 DB_DATABASE= bluehacks
 DB_USERNAME= root
 DB_PASSWORD=

Database

Option 1: For best experience, create a database named "bluehacks" and import the bluehacks.sql file in the project to see the full functionality of the website.
Option 2: run following command:

> php artisan migrate
> php artisan db:seed

To run the project:

> php artisan serve

The project should be up and running on your web server with: localhost:8000/

To Access Administrator

To access the admin side of the system: localhost:8000/login

Credentials:

Email: admin@admin.com
Password: admin

About the System

CodeJuan (CodeOne) aims to equip the public with the essential knowledge on Disaster Risk Reduction. CodeJuan is developed to inform and encourage the Filipino people to prepare, respond and put emphasis on emergencies. And that is through having an updated background of latest announcements from Local Government units regarding human-induced or natural disasters. Furthermore, it is a reference used for safety procedures, disaster management, contact services, and public directory.

Project Modules/Features

Administrator

A page which will allow pre-registered admin accounts to login and view a list of registered users and their relevant details. This area can use a minimalist layout that is different to the design. Administators can manage their website content; add, edit, delete the content that is displayed to the users.

Modules:

Dashboard - displays at a glance information or summary of data specific to the donations.
Map - Displays the evacuation centers.
Alerts - Admin user post alerts/announcements through this module.
Disasters - Admin user dynamically posts content for different disasters.
Build A Kit - Admin user dynamically creates emergency kits and supplies.
Evacuation Centers - Admin user can add new locations and evacuation centers which will be displayed in the map through markers.
Hotline Directory - Admin user can add hotlines and important contacts related to emergencies.
Donations - Admin can monitor donations and post donation drives.

Client

Home - Highlights the features of the website.
Alerts - Shows important announcements.
Disaster - Displays relevant information on the different disasters. It aims to increase the awareness and knowledge of users.
Prepare - This feature aims to equip the users with the essentials to increase safety.
Kit - Displays needed kits and supplies.
Plan - Aims to make the users plan for the future in case of emergencies.
Safety Skills - Aims to inform the users on survival skills.
Resources - Displayes lists of resources that the users can use in case of emergency.
Evacuation Centers - List of evacuation centers with location and contact.
Directory - List of important hotlines for emergencies and calamities.
Map - Aims to provide users with knowledge of the different evacuation centers through mapping which marks the different centers. It also features routing that the user can use for directions.

Laravel PHP Framework

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.

Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.

Official Documentation

Documentation for the framework can be found on the Laravel website.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at taylor@laravel.com. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.

NitroQ/CodeJuanCMS