0% found this document useful (0 votes)
17 views9 pages

WhatsJet Technical Guide 5.5.0

The document is a technical guide for the WHATSJET product version 5.5.0, detailing server requirements, file structure, and FAQs. It outlines the organization of code within the Laravel framework, including directories for controllers, models, and components, as well as frontend assets. Additionally, it provides information on email configuration and important notes for application debugging and security practices.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
17 views9 pages

WhatsJet Technical Guide 5.5.0

The document is a technical guide for the WHATSJET product version 5.5.0, detailing server requirements, file structure, and FAQs. It outlines the organization of code within the Laravel framework, including directories for controllers, models, and components, as well as frontend assets. Additionally, it provides information on email configuration and important notes for application debugging and security practices.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

By

Technical Guide

Product Version: 5.5.0


Table of Contents
File Structure .......................................................................................................................... 4
Controllers .....................................................................................................................................4
File Structure .................................................................................................................................4
public/dist Folder ................................................................................................................................................. 5
media-storage ...................................................................................................................................................... 5

FAQs ...................................................................................................................................... 6
Emails .................................................................................................................................... 7
Please Note ............................................................................................................................ 8
Thank You ............................................................................................................................. 9

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


Server Requirements
Server requirements as given below:
• PHP >= 8.1.0
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension
• Tokenizer PHP Extension
• XML PHP Extension
• Ctype PHP Extension
• JSON PHP Extension
• BCMath PHP Extension
• Fileinfo PHP Extension
• GD Library (>=2.0)
• Curl
• MySQL 5.7 +

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


File Structure
While development we follow some of our rules to organize the code. For this we have made
some changes to the Laravel framework files as follows:

Controllers
By default, Laravel placed all its controllers under Http/Controllers folder, our component
controllers are placed App/Yantrana/Components/ in their respective component

File Structure
All the component code is placed under the folder called Yantrana under the app folder. This
folder contains other folders as follows:
• __Laraware – a folder contains a core file for the various classes which mostly extends
Laravel classes & helper, which are restricted to change while development.
• Base – is also contains the base files for various classes which mostly extended using
__Laraware classes.
• Support – contains various & common helpers & classes.
• Services – contains various & common required service classes.
• Components – This is main folder which contains all the business logic in to its own
modules as follows:
o Component Folder
Each component has its own folder structure as follows:
• Models – Contains all the model files.
• Controllers – contains all the controller files.
• Repositories – contains all the repositories which treated as data-layer.
• Requests – contains the request files mostly for forms.
• Blueprints – contains the interface files for required classes.

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


• [Link] – Its treated as most important file for the component

Each component can have multiple sub components.

public/dist Folder

This folder contains all the frontend related files like JS, CSS etc.
In the CSS & JS folder you will find files named like: [Link], [Link] etc.
For the application 2 types of files are there one is minified (.min) & other one is normal non-
minified files (.src). By default, application uses .min files & called in to below named views which
are placed under resources/views using __yesset helper functions, which dynamically finds the
files on given file named & path contains *.

media-storage

This folder stores all the uploaded media of the files like images etc. if not other storage options
configured.
For the most other things you can consider Laravel PHP Framework documents at below link:
[Link]

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


FAQs

Question:
How I can change homepage?

Answer:
You need to edit [Link] file under resources/views folder.

--------------------------------------------------------

Question:
I am using shared hosting and want to target public folder without public keyword in address
bar?

Answer:
You need create .htaccess file with following code and place it into base folder (parent of public
folder)

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteRule ^(.*)$ public/$1 [L]
</IfModule>

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


Emails

For some action system uses email by default it uses php mail function as driver you can change
it using .env file for more info see [Link]
System uses resources/views/emails/[Link] as main view you can manage header &
footer from here. Also, all the email view files are stored in resource/views/email folder.

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


Please Note
Here is some information you should aware of.

1. If you set APP_DEBUG=true in the .env file. the system also logs lot of information in to
the Browser’s Console panel for debugging, so please keep it false for the production
uses.
2. When the APP_DEBUG=false in the .env file. the page’s markup automatically minified
3. Admin Email is sent in English Only.
4. For the added protection sensitive information like username, passwords are sent
encrypted to the server using OpenSSL, when form gets submitted When form has data-
secured=true the form inputs get encrypted client side and gets decrypted server side.

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024


Thank You
This information would help you to customize understand application better

Once again thank you so much for purchasing this product. I would be glad to help you if you
have any questions relating to this product. No guarantees, but I will do my best to assist.

We are small team of Mobile and Web Designer & Developers, here are some of the Great tools
and technologies we use day2day for the development: HTML5, CSS3, jQuery, PHP, Laravel,
Flutter etc.

We also build iOS & Android Application.

If you need any Customization Work / Support on this Product or having any project for us.
Please feel free to email us at contact@[Link]

Thank You & Good Luck

[Link] | contact@[Link] net | @livelyworks |


[Link]

WHATSJET – TECHNICAL GUIDE - Friday, October 18, 2024

Common questions

Powered by AI

The WHATSJET development team uses a variety of tools and technologies including HTML5, CSS3, jQuery, PHP, Laravel, and Flutter. HTML5 and CSS3 are foundational for creating responsive and semantically structured webpages. jQuery complements these with advanced client-side scripting capabilities. PHP and Laravel are used for robust backend development, offering a powerful framework for managing databases and server-side logic. Flutter enables cross-platform mobile application development, providing a cohesive interface for iOS and Android, allowing for broad reach and intelligent sharing of business logic .

In WHATSJET, the 'public/dist' folder contains all frontend files, including JavaScript and CSS. These files are available in minified and non-minified formats, with the application defaulting to the minified versions for performance optimization. The 'media-storage' folder stores all uploaded media files, serving as the default storage location unless alternative configurations are specified .

WHATSJET features include APP_DEBUG toggling in the '.env' file, which, when enabled (APP_DEBUG=true), logs a significant amount of debugging information to the browser's console. In a production environment, APP_DEBUG should be set to false as its true setting can expose sensitive data and increase security risks. Additionally, enabling APP_DEBUG=false also ensures that the page's markup is automatically minified for better performance .

In WHATSJET, security in form submissions is enhanced by encrypting sensitive information like usernames and passwords using OpenSSL before transmission to the server. When a form has the attribute 'data-secured=true', form inputs are encrypted client-side with OpenSSL and decrypted server-side. This ensures that sensitive data is secure during transmission .

The modified Laravel framework in WHATSJET is structured to accommodate multiple components and subcomponents by placing each business logic module under its own folder within 'Yantrana/Components'. Each component has its dedicated folders for 'Models', 'Controllers', 'Repositories', 'Requests', and 'Blueprints', allowing for modular code organization. The 'Engine.php' file is particularly significant, encapsulating crucial component functionalities. This component-based file structure helps in efficiently managing business logic separate from presentation and data access layers .

During the development of WHATSJET, the developers follow specific rules for organizing code which entails modifications to the Laravel framework files. The component code is placed under the 'Yantrana' folder within the 'app' directory. This folder houses several other subfolders: '__Laraware' for core files extending Laravel classes, 'Base' for base class files, 'Support' for common helpers, 'Services' for required service classes, and 'Components' for the main business logic divided into modules. Each component's structure includes its own 'Models', 'Controllers', 'Repositories', 'Requests', and 'Blueprints', which impacts the standard placement of controllers from 'Http/Controllers' to 'App/Yantrana/Components/'. These changes help in modular handling of business logic .

WHATSJET requires PHP version 8.1.0 or higher, along with several PHP extensions such as OpenSSL, PDO, Mbstring, Tokenizer, XML, Ctype, JSON, BCMath, Fileinfo, and GD Library version 2.0 or higher. Additionally, Curl and MySQL version 5.7 or above are necessary for deployment .

In shared hosting environments, to target the public folder without needing the 'public' keyword in the address bar, an .htaccess file with specific rewrite rules must be created. This file is placed in the base folder (parent of the public folder) and contains code to rewrite requests to the public directory, effectively hiding the 'public' keyword from URLs .

To alter email functionalities in WHATSJET, you can modify the '.env' file to change the email driver from the default PHP mail function to another preferred driver. The primary email view templates are stored in the 'resource/views/email' folder, with the main view located in 'resources/views/emails/index.blade.php', from which headers and footers can be managed .

To modify the homepage in WHATSJET, you need to edit the 'outer-home.blade.php' file located in the 'resources/views' folder. This file directly handles the layout and content of the homepage .

You might also like