Forem: Emmanuel Larbi

Creating A Basic REST API in Laravel 9

Emmanuel Larbi — Wed, 23 Nov 2022 14:07:37 +0000

In this tutorial, I am going to take you through the basics in building a REST API in Laravel. But before that lets take a quick glance into what a REST API is.

What is REST API?

A REST API, commonly referred to as a RESTful API, is a web API that complies with the restrictions of the REST architectural style and enables communication with RESTful web services. Computer scientist Roy Fielding came up with the acronym REST, which stands for representational state transfer.

Create a new `Laravel project`

composer create-project laravel/laravel basic_laravel_api

or using Laravel Installer

laravel new basic_laravel_api

and move into the directory

cd basic_laravel_api

Create a model and migration

php artisan make:model Post -m

Update and migrate your database

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=basic_laravel_api
DB_USERNAME=root
DB_PASSWORD=

Post table update

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->increments('id');
            $table->string('title');
            $table->string('body');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('posts');
    }
};

Then run your migrations

php artisan migrate

Create and Update your Controller

php artisan make:controller Api\\PostController --model=Post

Api Controller

<?php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $posts = Post::all();

        return response()->json([
            'status' => true,
            'post' => $posts
        ]);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
        $post = Post::create(request()->all());

        return response()->json([
            'stauts' => true,
            'post' => $post
        ]);
    }

    /**
     * Display the specified resource.
     *
     * @param  \App\Models\Post  $post
     * @return \Illuminate\Http\Response
     */
    public function show(Post $post)
    {
        $post = Post::find($post)->first();

        return response()->json([
            'status' => true,
            'post' => $post
        ]);

    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Models\Post  $post
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Post $post)
    {
        $post->update(request()->all());
        return response()->json([
            'status' => true,
            'post' => $post
        ]);
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  \App\Models\Post  $post
     * @return \Illuminate\Http\Response
     */
    public function destroy(Post $post)
    {
        $post->delete();

        return response()->json([
            'status' => true,
        ]);
    }
}

Define your routes

open routes/api.php

<?php

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use App\Http\Controllers\Api\PostController;

Route::apiResource('v1/posts', PostController::class);

Start Laravel Server

php artisan serve

Preview using Postman

`GET` all Post

Create a Post. `POST`

`GET` a specific post

Update a post. `PUT/PATCH`

`DELETE` a post

Convert audio file to text - Python

Emmanuel Larbi — Thu, 06 Oct 2022 15:52:31 +0000

I had an audio file that I wanted it in text form. Listening and typing it manually is a hassle, as a programmer I made a quick research on how to convert audio files to text.
Let's get started.

Requirements

speech_recognition

pip install speech_recognition

After installation import the package

import speech_recognition

Import the audio file to be converted

audio_file = "sample.wav"

initialize the speech recognizer

 sp = speech_recognition.Recognizer()

open the audio file

with speech_recognition.AudioFile(audio_file) as source:

Next is to listen to the audio file by loading it to memory

audio_data = sp.record(source)

Convert the audio in memory to text

converted_text = sp.recognize_google(audio_data)

Print out the converted text

print(converted_text)

Done.

This script works for short audio files and the file format should be .wav

Complete Code

#import package
import speech_recognition

#import audio file
audio_file = "sample.wav"

# initialize the recognizer
sp = speech_recognition.Recognizer()

# open the file
with speech_recognition.AudioFile(audio_file) as source:
    # load audio to memory
    audio_data = sp.record(source)
    # convert speech to text
    text = sp.recognize_google(audio_data)
    print(text)

Sending mails in Laravel 9

Emmanuel Larbi — Fri, 02 Sep 2022 11:17:27 +0000

Laravel Mail

Laravel has made mail sending simple, clean, fast, and reliable by providing simple email API component using drivers like SMTP, Mailgun, Postmark, etc. The emails can be sent through a cloud or local service. Let's setup a simple mail locally using laravel.

Steps

Get a mail service provider. We will use Mailtrap as our test provider.

Create an account and copy and paste the configuration for Laravel in `.env` file.

You can skip this if you already have a mail provider.

MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=//username
MAIL_PASSWORD=//password
MAIL_ENCRYPTION=tls

Create a new laravel project

composer create-project laravel/laravel laravelmail

Make a mailable class.

php artisan make:mail SimpleMail

The mail class can be found at `/app/Mail/SimpleMail.php`. Copy this block of code and replace it with yours.



<?php
    namespace App\Mail;
    use Illuminate\Bus\Queueable;
    use Illuminate\Contracts\Queue\ShouldQueue;
    use Illuminate\Mail\Mailable;
    use Illuminate\Queue\SerializesModels;

    class SimpleMail extends Mailable
    {
        use Queueable, SerializesModels;

        /**
        * Create a new message instance.
        *
        * @return void
        */
        public function __construct()
        {
            //
        }

        /**
        * Build the message.
        *
        * @return $this
        */
         public function build()
        {
            return $this->from(config('MAIL_USERNAME'))
            ->view('mail.simplemail');
        }
    }

Create a controller for mailable class

php artisan make:controller SimpleMailController

The created controller can be found at `app/Http/Controllers/SimpleMailController.php`, replace this code with yours.



<?php

    namespace App\Http\Controllers;

    use Illuminate\Http\Request;
    use Mail;
    class SimpleMailController extends Controller
    {
        public function index() {
            $passingDataToView = 'Simple Mail Send In Laravel!';
            $data["email"] = 'test@mail.com';
            $data["title"] = "Mail Testing";

            Mail::send('mail.simplemail', ['passingDataToView'=> $passingDataToView], function ($message) use ($data){
                $message->to($data["email"],'John Doe');
                $message->subject($data["title"]);
            });;

            return 'Mail Sent';
        }
    }

Create a view for the mailable class.

Goto the resource folder and create a folder named `mail`, then create a blade file named `simplemail` inside the `mail` folder. Your file path should look like this `resources\mail\simplemail.blade.php`. Then paste this code inside the `simplemail.blade.php` file.



 <div style="background-color: white;border: 2px solid #0f0870;box-shadow: 20px -13px 1px 1px #0f0870;
        width: fit-content;padding: 1rem 1rem;font-family: system-ui;">
            <h4 style="text-align: center; font-size: large;"> {{ $passingDataToView }}</h4>
            <h4 style="font-size: medium"> This is a custom mail</h4>
            <p style="font-size: medium">
                Laravel provides flexiblity for you to design your mail format to your liking
            </p>
            <p style="font-size: medium">
                Enjoy and explore the world of infinite possibilities 
            </p>
            <small>Thanks for checking this tutorial out.</small>
            <p style="display:flex;justify-content: center;align-items: center;">
                <a style="padding: 1rem;background-color: #0f0870;
                    width: max-content;color: white;text-decoration: none;" 
                    href="https://medium.com/@manu_tech">
                    Custom Button
                </a>
            </p>
    </div>

Create a route to send mail.



<?php

    use Illuminate\Support\Facades\Route;
    use App\Http\Controllers\SimpleMailController;
    /*
    |--------------------------------------------------------------------------
    | Web Routes
    |--------------------------------------------------------------------------
    |
    | Here is where you can register web routes for your application. These
    | routes are loaded by the RouteServiceProvider within a group which
    | contains the "web" middleware group. Now create something great!
    |
    */

    Route::get('/', function () {
        return view('welcome');
    });

    Route::get('sendmail', [SimpleMailController::class, 'index']);

Preview

Now run the server

    php artisan serve

Then goto `http://127.0.0.1:8000/sendmail`

In mail inbox (Mailtrap)

Generating GitHub Personal Access Token (GPAT)

Emmanuel Larbi — Sun, 07 Aug 2022 16:11:00 +0000

GitHub Personal Access Tokens (GPAT) are at times required instead of passwords when working with Git. It should be kept secret from others as they might get access to your repositories if they have the token. You might have encountered the need for GPAT when making a push to your GitHub repo or when creating CodeBuilds in AWS or needed for other reason.

This is simple and let's dive right in to generate our GPAT in less that a minute.

Login to your account and go to Settings

Scroll down and click on Developer Settings.

Click on Personal Access Token

Click on Generate new token

Type any name you prefer for the token

Select the expiry duration for the token

This defines how long the token will be valid

Select the scopes for the token

Scopes generally means, the permissions that the access token should have. Select them carefully, you might mistakenly delete all or loose access to your repositories.

Finally click on Generate token

Token Preview

Your access token also serves as password and you don't wanna loose it to anyone.

Bootstrap 5 Auth Scaffolding - Laravel 9

Emmanuel Larbi — Thu, 04 Aug 2022 21:40:00 +0000

Hola Devs, are you thinking of adding authentication to your Laravel project and having a tough time going about it. Don't worry about that anymore, let's create that bootstrap auth scaffold in a few minutes in our project. Just follow along and you are good to go.

You need to have the latest version of node installed for this turtorial to be a success

Create a Laravel 9 project.



composer create-project laravel/laravel authScaffold

Navigate to the directory



cd authScaffold

Create a database and set it up in .env file

Install Laravel ui



composer require laravel/ui

Install Bootstrap Auth Scaffolding



php artisan ui bootstrap --auth

Install and build npm



npm install && npm run dev

npm run build

Make a migration



php artisan migrate

Start local server



php artisan serve



http://localhost:8000/

Preview

Home Page

Log in Page

Register Page

How To Access PostgreSQL Globally in Windows

Emmanuel Larbi — Fri, 17 Jun 2022 15:18:24 +0000

If you are getting the error below after installing PostgreSQL don’t panic, just follow along with this tutorial and it’s gonna be solved.

This tutorial is simplified to help everyone to know how to add PostgreSQL to user or system variable(path) which can be accessed globally with minimum stress.

Let’s begin!

Normally, you will have to navigate to your PostgreSQL bin directory to copy the path which takes a while. Instead, I will provide the path for you to make everything quick and easy.

Path to postgresql bin directory —

C:\Program Files\PostgreSQL\14\bin

NB: Change \14\ to the version of Postgres you have installed

Step 1

Copy the path to your Postgres bin directory provided above.

Step 2

Press the windows start button and search for env then click open

Step 3

Click on Environment Variables

Step 4

Double click on Path

Step 5

Click on New

Step 6

Paste the [PostgreSQL bin](C:\Program Files\PostgreSQL\14\bin) path you copied. Then click ok recursively to close all windows

Step 7

Close all instances of your terminal then reopen it.

NB: If you are using terminals in VS Code Editor, you will have to restart VS Code Editor for the changes to take effect

Step 8

You are done

And now you can log in to Postgres without using the default psql shell.

Hope this solves your issue about using Postgres globally.

Thank You

Forem: Emmanuel Larbi

Creating A Basic REST API in Laravel 9

Create a new Laravel project

Create a model and migration

Update and migrate your database

Post table update

Create and Update your Controller

Api Controller

Define your routes

Start Laravel Server

Preview using Postman

GET all Post

Create a Post. POST

GET a specific post

Update a post. PUT/PATCH

DELETE a post

Convert audio file to text - Python

Requirements

After installation import the package

Import the audio file to be converted

initialize the speech recognizer

open the audio file

Next is to listen to the audio file by loading it to memory

Convert the audio in memory to text

Print out the converted text

Sending mails in Laravel 9

Laravel Mail

Steps

Get a mail service provider. We will use Mailtrap as our test provider.

Create an account and copy and paste the configuration for Laravel in .env file.

Create a new laravel project

Make a mailable class.

The mail class can be found at /app/Mail/SimpleMail.php. Copy this block of code and replace it with yours.

Create a controller for mailable class

The created controller can be found at app/Http/Controllers/SimpleMailController.php, replace this code with yours.

Create a view for the mailable class.

Goto the resource folder and create a folder named mail, then create a blade file named simplemail inside the mail folder. Your file path should look like this resources\mail\simplemail.blade.php. Then paste this code inside the simplemail.blade.php file.

Create a route to send mail.

Preview

Now run the server

Then goto http://127.0.0.1:8000/sendmail

In mail inbox (Mailtrap)

Generating GitHub Personal Access Token (GPAT)

Login to your account and go to Settings

Scroll down and click on Developer Settings.

Click on Personal Access Token

Click on Generate new token

Type any name you prefer for the token

Select the expiry duration for the token

Select the scopes for the token

Finally click on Generate token

Token Preview

Bootstrap 5 Auth Scaffolding - Laravel 9

Create a Laravel 9 project.

Navigate to the directory

Create a database and set it up in .env file

Install Laravel ui

Install Bootstrap Auth Scaffolding

Install and build npm

Make a migration

Start local server

Preview

Home Page

Log in Page

Register Page

How To Access PostgreSQL Globally in Windows

Create a new `Laravel project`

`GET` all Post

Create a Post. `POST`

`GET` a specific post

Update a post. `PUT/PATCH`

`DELETE` a post

Create an account and copy and paste the configuration for Laravel in `.env` file.

The mail class can be found at `/app/Mail/SimpleMail.php`. Copy this block of code and replace it with yours.

The created controller can be found at `app/Http/Controllers/SimpleMailController.php`, replace this code with yours.

Goto the resource folder and create a folder named `mail`, then create a blade file named `simplemail` inside the `mail` folder. Your file path should look like this `resources\mail\simplemail.blade.php`. Then paste this code inside the `simplemail.blade.php` file.

Then goto `http://127.0.0.1:8000/sendmail`