Forem: Mohammed Samgan Khan

TEST TEST TEST

Mohammed Samgan Khan — Thu, 13 Mar 2025 16:47:17 +0000

TEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TESTTEST TEST TEST

How to Contribute to Laravel: A Step-by-Step Guide

Mohammed Samgan Khan — Sun, 23 Jun 2024 02:01:16 +0000

Every laravel developer has this wish to contribute to laravel, but it's hard to find a starting point on how to do that. where to start, how this, what that, all these questions and searching on the internet won't be much of a help. There are many articles on how to do laravel but almost no detailed information on how to contribute to this master framework.

In this article, we will try to find out answers to some of those questions.

Familiarize Yourself with Laravel

Before jumping in the contributing, I would highly recommend that you familiarize yourself with laravel. it can be done in the following three ways.

Read the Documentation
Build Projects
Engage with the Community

If you think you have overcome the above-mentioned requirement, let's get started.

Fork the Laravel Framework Repository

The first step in the contribution is to fork the laravel framework repository in your GitHub account.

Pro Tip: While forking uncheck the latest release branch only check. Else you will have only the latest release branch in your account.

Local Setup

Follow the steps below to set up the workflow on your local machine.

Create a new Laravel project

Create a new laravel project. You can get instructions for that from here. As of this time, laravel 11 is the latest version so that will be our base for the work. Once you have the setup up and running we will start our development changes. You can also use the following command.



composer create-project laravel/laravel laravel-app

Clone the Fork on your machine

Use the following command to clone the fork to your local machine



git clone "path to your git repository"

Pro Tip: I suggest making the directory structure as shown in the picture below.

Updating the composer.json

Once all the things are in place, update the content of composer.json with the following content.



"minimum-stability": "dev",
"repositories": [
        {
            "type": "path",
            "url": "../laravel-framework"
        }
    ]

After that run composer update

Now you have your Laravel app using your local copy of the laravel framework.

Create a Feature or Bug Branch

Create a new branch on your local machine and make the required changes. You can use the following command to create a new branch.



git checkout -b feature/new-feature

Once the changes are done, push the changes to your repository.

Create a new Issue and submit the PR about that issue.

Create a new issue in the parent repository, in our case the laravel/framework repository. Be as detailed as you can be for the update you are doing.

And there we go. You have your contribution done. Ones verified by the Laravel maintainers it can move forward.

Fell free to comment below in case of feedback or questions.

How to Cache in NodeJs APIs

Mohammed Samgan Khan — Fri, 01 Mar 2024 17:54:17 +0000

Speed is what all web/mobile apps need. And with growing database size, the speed is the first thing that takes a hit. Comes cache to rescue.

A cache can be defined as storing data in RAM for quick access (faster than getting data from DB), also we can store the results for regular calculations in the cache to save time on recalculation again and again.

There are various types of available caches, you can research that for a more detailed understanding. We will not cover that in the scope of this article.

How to implement cache

Implementing a cache is more or less a kind of art, depending on your requirements and available methodologies. What I prefer is using Redis for cache. It's easy to use, fast and reliable.

Installation

npm install redis

Usage

const { createClient } = require("redis")

const  cacheing = async () => {
    let redisConfig = {
        host: "localhost",
        port: 6379,
        username: "",
        password: "",
        database: 0
    }

    const client = createClient(redisConfig)

    client.on("error", (err) => console.log("Redis Client Error", err))
    await client.connect()

    // setting cache
    await client.set("key", "string_value")

    // getting cache
    const value = await client.get("key");
    //If the key does not exist, the value will be null
}

OR

or you can use Framework X (AKA Fx). Which comes with a supper charges cache in build. Fx cache not only caches your data but also updates the cached data in a given duration so that your cache never goes out of new data, checking when the given data was accessed. AND all this with an implementation time of less than a min.

To Know about how to get started with Fx, please follow this link.

Once up and running, you can use the cache as follows.

const { setCache, getCache } = require("@3rdplanet/x-core/cache")

exports.index = async (req, res) => {
    let responseData = await getCache(req.url)

    if (responseData) {
        return res.send(successResponse("cache found...", responseData.response))
    }

    let someCalculationAnswer = someCalculations(1, 1, 1)

    setCache(req.url, someCalculationAnswer, {
        function: someCalculations,
        params: [1, 1, 1]
    }).then(() => {})

    return res.send(successResponse("cache in progress...", someCalculationAnswer))
}

Also, you will need to add the following keys in your .env file.

CACHE_UPDATE_INTERVAL - The interval in seconds to update the cache. The default is 10 seconds.
CACHE_EXPIRE_TIME - The time in seconds to expire the cache. The default is 60 seconds.

You can learn more about Fx cache here.

Feel free to ask questions in the comments if you have any sort of doubts or queries.

How to create REST API in NodeJs

Mohammed Samgan Khan — Mon, 26 Feb 2024 16:46:39 +0000

APIs are one of the most vital parts of any web or mobile application. I am assuming that you are already familiar with the concept of API, what they are, and what they do. Yet, just for the same of this article let me define what an API is.

APIs are mechanisms that enable two software components to communicate with each other using a set of definitions and protocols. For example, the weather bureau’s software system contains daily weather data. The weather app on your phone “talks” to this system via APIs and shows you daily weather updates on your phone.

source: https://aws.amazon.com/what-is/api/

Since we have an overview of what APIs are, let's dive into the "How" of the process.

We will use Framework X for creating the API in Node Js.

Framework X or Fx is a new NodeJs framework based on express. Fx provides you with everything you need to get started with your APIs. Fx just does not stop at being a starter kit, it has all the what you need to scale your application. The best part is that it's created for the developer by the developers focusing on ease and speed of development.

You can get more details about Fx, here: https://www.frameworkx.info/

Getting Started

Getting started is as easy as running this command. (make sure you have node installed.)

npx @3rdplanet/framework-x

Answer the question asked while installing. and you are good to go. Everything you need is already installed, and up and running. Refer to the documentation for details, it's straightforward, simple, and easy to understand.

Feel free to ask questions in the comments if you have any sort of doubts or queries.

I just enabled TS support in the framework I am working on, should I stop?

Mohammed Samgan Khan — Fri, 08 Sep 2023 19:49:45 +0000

hi,

I am working on an open-source NodeJs Framework,

https://github.com/3rd-planet/framework-x

I just enabled the TS support for it and planned to create every feature in both JS and TS. But, now there is an ongoing debate over the dropping of TS by some big giants. What should I do? Ignore the debate and keep on going or I should drop TS too?

Your suggestion will be appreciated.

How to check all ports in use in linux/Mac

Mohammed Samgan Khan — Thu, 10 Aug 2023 21:10:36 +0000

When you work with NodeJS and micro-service architecture by the end of the day there are a number of ports which you start using.

To check which port is already in use, use the following command.

For Linux

netstat -lnp | grep node

-l: Show only listening ports.
-n: Show numerical addresses instead of resolving hostnames.
-p: show type of port (grep works on this)

ss -tuln

-t: Show TCP ports.
-u: Show UDP ports.
-l: Show only listening ports.
-n: Show numerical addresses instead of resolving hostnames.

lsof -i -n -P | grep node

i: Specifies that you're interested in network-related information, specifically open network connections and listening sockets.
-n: Prevents lsof from attempting to resolve IP addresses to hostnames. Shows numerical IP addresses instead.
-P: Prevents lsof from resolving port numbers to service names. Shows numerical port numbers instead.

For Mac

lsof -i -n -P | grep node

i: Specifies that you're interested in network-related information, specifically open network connections and listening sockets.
-n: Prevents lsof from attempting to resolve IP addresses to hostnames. Shows numerical IP addresses instead.
-P: Prevents lsof from resolving port numbers to service names. Shows numerical port numbers instead.

Additionally, you can use graphical tools like lsof and network monitoring tools like nmap for more advanced analysis of open ports and network connections.

How to create and use a custom middleware in laravel 10

Mohammed Samgan Khan — Wed, 09 Aug 2023 21:47:19 +0000

Creating a custom middleware in Laravel is a good way to add custom logic to the request-response cycle. Laravel itself use a number of middleware for specific tasks. Middleware can be used for tasks ranging from authentication, authorization, logging to tasks like adding data to request etc. etc. etc..

Below is a step-by-step guide showing how to create a middleware in laravel.

Create the Middleware

To create a middleware use the following command in your terminal.

php artisan make:middleware CustomMiddleware

This command will create a new middleware file named CustomMiddleware.php in the app/Http/Middleware directory.

The file create will look something like this

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

class CustomMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param Closure(Request): (Response) $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        return $next($request);
    }
}

Update the Middleware

The entire logic goes in the handle function. You can modify the request, perform checks, and take actions based on the conditions you define.

Register the Middleware

To make your middleware functional, you need to register it in Laravel's middleware stack. Open the app/Http/Kernel.php file and locate the $middleware array. Add an entry for your custom middleware class. Make sure you use the complete file path of the middleware.

protected $middleware = [
    // Other middleware entries
    \App\Http\Middleware\CustomMiddleware::class,
];

Note: if you will add the entry to $middleware array, your middleware will be applied on all the request through out the application. Including web and api. Add to $middlewareGroups.web for web requests only and $middlewareGroups.api for api requests only.

Applying the Middleware

Now this middleware can be applied to routes or route groups.

Route::get('/example', 'ExampleController@index')->middleware('custom')->name('example');

In this example, the custom middleware will be applied to the example route.

For more details you can always refer to the Laravel documentation for the most up-to-date information and additional middleware options. Laravel Middleware Documentation

Python script to run multiple servers simultaneously on a local machine on Mac.

Mohammed Samgan Khan — Tue, 26 Jul 2022 19:33:00 +0000

There are a number of times we have a bunch of servers we need to run to fully run an application, yes i am talking about the microservice arch. It's annoying to go to each repo and get the server running. Below is the script for making it automated.


#!/usr/bin/python3

"""
Script that starts the servers from the "services" array.
services = [
  {
    "name": "service_name",
    "path": "path_to_service",
    "command": "command_to_run",
  },
  ...
]
for a single server, please pass the name of the service to start...
author: msamgan
created at: 2022-05-01
updated at: 2022-07-22
version: 1.1.0
signature: ./server | ./server <service_name>
"""

import os
import sys

services = [

]

# uncomment if on mac os..
# os.system("say 'booting shopini servers'")
os.system("sleep 1")

n = len(sys.argv)

serverCommand = ""
for service in services:
    if n > 1:
        if service["name"] != sys.argv[1]:
            continue

    # say = "say 'booting " + service["name"] + " server'"
    # os.system(say)
    os.system(
        "ttab.sh -w -t '"
        + service["name"]
        + "' -d "
        + service["path"]
        + " "
        + service["command"]
    )

# os.system(
#     "say 'all shopini servers are running at there full potentials, have a nice day!'"
# )
# kill command: kill -9 $(lsof -ti:5100)

The ttab.sh library you will need

function to round up a float number to next point five like 3.3 to 3.5, 3.8 to 4

Mohammed Samgan Khan — Tue, 26 Jul 2022 19:17:11 +0000

If you are from the shipping industry you face this problem a lot of time where you charge per 0.5 kg. In this kind of case, you need to make the weight from float to round up.

here is a php function to achieve that.

How to Add Laravel Pint to VS Code Formatter

Mohammed Samgan Khan — Fri, 24 Jun 2022 19:20:40 +0000

What is laravel pint

as in the defination by the official repository,

Laravel Pint is an opinionated PHP code style fixer for minimalists. Pint is built on top of PHP-CS-Fixer and makes it simple to ensure that your code style stays clean and consistent.
-- laravel/pint

and as per me, Pint is the so far most sophisticated code formatter i have ever user in the reference of PHP. You can find more details about laravel/pint here.

Installation

composer require laravel/pint --dev

General Usage

to use the pint binary all you have to do is run the following command in the root of you laravel project.

./vendor/bin/pint

Configuration

The default setup of laravel pint does not require any configuration and as per the official docs, it for PSR-12 Style Guide. Still if you are unhappy with some default rules you can change then by creating a pint.json in root of your project, and adding the preset to it.

Currently the following preset are supported

psr12
laravel
symfony

Since Pint is based on PHP-CS-Fixer the configuration rules can be found here.

Sample pint.json

{
    "preset": "symfony",
    "rules": {
        "concat_space": {
            "spacing": "one"
        }
    }
}

Binding laravel pint with VS Code

So far we are good to use laravel/pint, but opening terminal and running a binary everytime you need to format id one hell of a job. To reduce that effort we will bind laravel/pint with our VS Code with the help of VS Code Task

Creating VS Code task for laravel pint

To create a task create a .vscode directory in rootof you project, if you don't have one.
Add a new file named as tasks.json to .vscode directory
add the following content to the new created file

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Pint Formatter",
            "type": "shell",
            "command": "./vendor/bin/pint",
            "problemMatcher": [],
            "presentation": {
                "reveal": "silent"
            },
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

You can run this task directly from the Tremial -> Run Tasks from the navigation, but will do it a bit more simpler.

Adding KeyBinding (Keyboard Shortcut) to Run laravel pint

Open Keyboard shortcut panel, either from file -> preferences -> keyboard Shortcuts or Ctrl+k Ctrl+s
Ones open click on the file icon on the top to open the json file of the keyboard shortcuts.
Ones open add the following lines to the file.

[
  {
    "key": "ctrl+shift+l",
    "command": "workbench.action.tasks.runTask",
    "args": "Pint Formatter"
  }
]

Now all you have to do is hit Ctrl + Shift + l and your laravel project will formatted with laravel pint.

The Extension

If you are more driven toward the extension approach you can get the above integration by using the following extension.

Vscode Laravel Pint Extension

show some support bby staring the repo

Conclusion

I have been using the unsatisfactory formatters from a long time. All of them have one thing but lack other. Laravel Pint is one who has it all, combining it with vscode is like proving you laravel project a super power.

Feel free to pick your brain in comments.

How to Add AppImage Application to Menu in Ubuntu (Linux)

Mohammed Samgan Khan — Wed, 22 Jun 2022 09:29:01 +0000

AppImages are the easiest to run compared. All you need to do is follow the steps mentioned below.

Step to use AppImage

Download the AppImage
Make the AppImage executable. (sudo chmod +x *.AppImage)
Run the file (./*.AppImage)

The challenging task is to make the AppImage accessible globally through he system like an installed application (in the menu)

you can achieve this by going through the following steps.

The remaining article is originally posted at...

https://msamgan.com/how-to-add-appimage-application-to-menu-in-ubuntu-linux

create-express-boilerplate to create new API projects in a secs

Mohammed Samgan Khan — Thu, 27 Jan 2022 19:54:49 +0000

Initiating a new project is as exciting as frustrating. Going through all the routine work just to get the basic engine started, yaa I know the pain.

create-express-boilerplate to Rescue

I along with the tremendous help of huda worked out the solution for you, in the form of create-express-boilerplate. It includes

Entire expressjs setup
Validation Integration with express-validator
Directory setups to provide you with less headache for where goes what
MVC architecture
DB support for both
Sequelize (MySQL and SQLite)
Mongoose (mongoDB)
Integrated JEST test Suite
Both Vanilla JS and Typescript support
Husky Support for pre-commit hooks
Great amount of inbuild helper functions

And many more to come..

you can install the setup by running

npx create-express-boilerplate

you can have complete Documentation Here

feel free to provide us with your review and feedback in the form of comments or issues on github. All your contributions are cardinally welcome.