• The Question
• Stepwise Implementation
• Prerequisites
• Installing laravel
• Configuring a database
• Project Documentation
  • Database Migrations
  • API Routes
    • Websites Routes
    • Posts Routes
    • Mailing List (Subscription Route)
  • Implementing the models
  • Implementing the controllers...
  • Assigning an Observer & listing to the events.
  • Notifying the User (Email)
• Links
  • Documentation:
  • API Implementation
• Ending thoughts.

Create a simple subscription platform (only RESTful APIs with MySQL) in which users can subscribe to a website (there can be multiple websites in the system). Whenever a new post is published on a particular website, all it's subscribers shall receive an email with the post title and description in it. (No authentication of any type is required).

• Install laravel
• Prerequisites
• Configuring a database
• Project Planning.
• Links
• Ending Thoughts.

• Assumed you have composer installed from https://getcomposer.org
• Assumed you have node installed from https://nodejs.org (optional)
• Assumed you are using a Visual Studios Code as your IDE. (optional)
• Assumed you have PHP>=7.* installed in your system with the path of the executable in your $PATH variable.

$ composer global require laravel/installer
$ laravel new your-app-name
$ cd your-app-name
$ composer update

If you use VS Code as your IDE, please continue with this command

$ code .

💡 Please open an integrated terminal for your laravel artisan commands.

By default, laravel & this project assumes you are using MySQL.

• Driver: MySQL
• Username: any_username
• Password: any_password
• Database: some_name

:alert: Please update the necessary credentials in the .env found in the project's root. If you do not find one, use the .env.local file to create one.

We have considered the following tables in the database:

1. A table for multiple websites is websites.
2. A table for posts on a website is posts.
3. A table for list of subscriptions is mailing_list.
4. A table for maintaining a email queue named jobs generated by php artisan queue:table.

The following tables define routes to the different API's.

Please append /api to the routes

Three models have been considered.

1. A model for Website
2. A model for Posts
3. A model for Subscribers

The routes above, have their respective controllers bound by the Models.

1. The WebsiteController, uses the Website Model to implement the routes defined for websites. The controller handles all functions of Create, Update, View/Read actions of a website.
2. The PostController, uses the Posts Model to implement the routes defined for posts Create, Update, View/Read actions of a post.
3. The MailingListController, uses the Subscriber Model to implement the routes defined for mailing-list/subscription. This controller is responsible for handling the mailing-list or subscription-table of a particular website.

A dedicated PostObserver is declared to observe for any new post created & dispatch a mailing job which is enqueued to the bottom of Queue.

The PostObserver is "booted" in the EventServiceProvider, defining that the Post Model is bound by this observer.

Notifications are not perfectly handled. There was no attention given to the templating. Only a working implementation can be guaranteed.

• To notify the subscriber about any new post (template by php artisan make:mail), NotifySubscriber is defined.
• An asyncronous queue job (template generated by php artisan make:job) SendEmailJob handles the queue as well as finally invokes the "notifying" with the help of NotifySubscriber.

The following links may be helpful:

1. Laravel Docs - https://laravel.com/docs [At the time of writing the version of the docs was 9.x]
2. PHP Docs - https://www.php.net/manual/
3. Composer - https://getcomposer.org

If you want to run the api, you can use the button below:

You can also use the JSON link to deploy on Postman.

The front-end of this application will be a work-in progress. With this simple application, I have actually learnt a lot more than any other projects undertaken.

Thanks to Team Inisev....

Thank You & Regards,

@anrcry (Anweshan Roy Chowdury)