Download the PHP package chandan07cse/elham without Composer

Elham - Inspiring You The Next - A Product Of UROSD Lab

:loudspeaker: Let's build together by not reinventing the wheel but assembling the wheels to reinvent a new :rocket:

:beginner: Version 1.0.0

:feet: Installation

:small_blue_diamond: First install composer globally(if you don't have it) by running the following commands
For Ubuntu

For Cent OS

:small_blue_diamond: Then install Elham by the following command(for latest stable releases)

:small_blue_diamond: But if you want Elham from its master branch, then you could certainly type it

:small_blue_diamond: Now cd into your_project_name/public & run by the php command

:small_blue_diamond: Note : For the rest of the project we'll run each & every command from the project directory. For that

:package: Dependencies

:small_blue_diamond: To check the list of dependencies Elham relies, run the command

:flashlight: Visual Dependencies

• To check the visual dependencies, please go to the link Visual Dependecies

:musical_keyboard: Elham Command Alias

:small_blue_diamond: Let's run the below command to run elham command if you are in Linux

:small_blue_diamond: But if you are in windows machine add the executibles in your path. If you are using Laragon then it can be

:small_blue_diamond: Now you can run elham command through out your project. To check run from the terminal if you are in linux enviornment

:small_blue_diamond: But if you are in windows, then

:violin: Build Controller Through CLI

:small_blue_diamond: Elham provides you the build:controller command

:small_blue_diamond: Check it by finding it in app/Controller directory of your project.

:small_blue_diamond: By default elham generates resourceful controller. But if you want you can always make a plain controller by running

:guitar: Build Model Through CLI

:small_blue_diamond: Elham also provides you build:model command

:small_blue_diamond: It'll create a model with necessary properties & methods based on your database table.

:saxophone: Build Form Through CLI

:small_blue_diamond: Elham ships with build:form command

:small_blue_diamond: A dummy blade form will be generated inside app/Views/_partials directory.

:musical_score: Build Validator Through CLI

:small_blue_diamond: Elham also provides you build:validator command

:small_blue_diamond: A validation class will be generated inside app/Validation directory.

:microphone: Help keyword for CLI generators

:small_blue_diamond: Now if you need any help just type

:small_blue_diamond: All the commands check the existing ones as well for simplicity.

:necktie: :dress: Elham Templating Engines

:small_blue_diamond: Elham ships with Blade and Plain view for rendering its View. But if you want you can use twig too. For that you will need to install TWIG by the following command

:palm_tree: :seedling: Elham Migrations & Seeding

:small_blue_diamond: As Elham used Phinx for migrations & seeding, so to use phinx command just run from the terminal

:small_blue_diamond: Now you'll be able to run phinx command. To make sure phinx running correctly, run in terminal

:small_blue_diamond: You'll get the list of Phinx command. To use phinx, first initialize it by the following command

:small_blue_diamond: A phinx.yml file will be generated. You need to customize it. Sample customization for development listed below

:small_blue_diamond: Phinx uses :camel: CamelCase for its functioning & it'll store the migrations & seeding inside db/migration & db/seeds directory respectively. So if you wanna create a migration for Students table, just run in terminal

:small_blue_diamond: A new unique migration for Students will be generated inside db/migrations directory of Elham like below

:small_blue_diamond: Now we not gonna use the change method for the migration. Beside we'll create two methods up() & down() for our migration & rollback. So for that we gonna code a bit something like below. Say we've our student table consisting with roll & name.

:small_blue_diamond: Now to migrate, run from terminal

:small_blue_diamond: It'll affect our default db/databse.sqlite hopefully. Now to rollback, just run from terminal

:small_blue_diamond: To explore more about Phinx, please read the :link:documentation.

:small_blue_diamond: Now for seeding, we just need to create the seeder class from the cli. Say, we need to create a UserSeeder to seed some datumn into users table. To create the UserSeeder class

:small_blue_diamond: We'll get the UserSeeder class inside db/seeds directory. Inside there, we'll get

:small_blue_diamond: Actually we can seed in :v: ways.

:one: Manual Seeding

:two: Faker Seeding

:small_blue_diamond: For Manual Seeding we can write something like this in UserSeeder class

:small_blue_diamond: Now run from terminal

:small_blue_diamond: If you wanna run a specific class then run

:small_blue_diamond: For faker seeding, we can write something like this in UserSeeder class

:soccer::basketball::football::baseball::tennis: Elham Playground

:small_blue_diamond: Elham also uses Psyshell for tinkering with its functionalities, so to use psysh command just run from the terminal

:small_blue_diamond: Now if you wanna tinkering with psyshell just run in terminal

:small_blue_diamond: You'll be into the Psyshell now. If you wanna start toying around then first initialize the proper environment. To init the environment, run in terminal

:small_blue_diamond: To init the database with eloquent, run in terminal

:small_blue_diamond: Now if you wanna query through Eloquent/Query Builder, create an instance of the Capsule

:small_blue_diamond: Now if you wanna play with User model, create an object of User by running in terminal

:small_blue_diamond: To get all data from User model, just run in terminal

:small_blue_diamond: And if you wanna query through PDO, create an instance of the PDO

:small_blue_diamond: If you wanna insert some data into users table using pdo, do the following

:small_blue_diamond: You can run every bit of eloquent & pdo queries along with other functionalities through Psyshell.

:calling: Elham API Call

:small_blue_diamond: Elham uses Unirest libraries for its api calling. Its pretty easy to call an api using the Elham's api method like below

:mag: Elham Vulnerability Scan

:small_blue_diamond: To check any vulnerable package issue in Elham, just run the following command

:house_with_garden: Elham Frontend Housekeeping

:small_blue_diamond: Elham uses Gulp for basic front-end housekeeping of tasks like minifying css,js, autoprefixing of css and so on & so forth. To use gulp, first install node js by the following command

:small_blue_diamond: After that we need to install gulp globaly by the following command in ubuntu.

:small_blue_diamond: But if you are in windows then in Laragon terminal type

:small_blue_diamond: As pacakge.json already ships with Elham. So you don't have to create it. To install gulp just run the following command

:small_blue_diamond: But if you are in windows, then run

:small_blue_diamond: The way Gulp work is - Everything is split into various plugins. So each plugin does one job & one job only. And that way we can pipe the output of one function to another. So we can say - Let's autoprefix this file & then minify it & then output it some file & then finally provide some sort of notifications. All of that stuff is really easy with Gulp.

:small_blue_diamond: So if we want to use plugins, we need to install some. Lets install, just to get started, How about minifying our css We can do that by running into ubuntu terminal

:small_blue_diamond: For windows run

:small_blue_diamond: Now if you wanna minifying the js then in ubuntu terminal

:small_blue_diamond: But if you are in windows then run in Laragon terminal

:small_blue_diamond: To use gulp, run from terminal

:strawberry: Elham Zero Second Deployment

:small_blue_diamond: Elham proudly compatibles with ngrok. So you can deploy it less than a second. For that you'll have to install node & nodejs-legacy by the following command

:small_blue_diamond: After that we gonna install ngrok through (npm)node package manager globally

:small_blue_diamond: Now we gonna deploy our project by just running the following command

:small_blue_diamond: Make sure you are running your project through port 8000. If you are using other port, then use that port to ngrok

:grapes: Elham Production Deployment

:small_blue_diamond: Don't worry it also supports any repo(Github,Gitlab,Bitbucket....) and any CI (Jenkins) and any server(Linux Distro. preferred) in deployment.