This Laravel project is designed to allow users to subscribe to websites and receive notifications via email whenever new posts are published. It includes functionalities for creating posts, subscriptions, and handling background email notifications.

• Create Posts: Admins can add new posts to their subscribed websites.
• Subscribe: Users can subscribe to websites to receive updates.
• API Documentation: Automatically generated with Scribe.
• Automated Tests:
• Email Notifications: Subscribers receive email notifications about new posts asynchronously through queued jobs intiated through laravel's command utility.

What things you need to install the software and how to install them:

• PHP >= 7.4
• Composer
• Laravel >= 11.0
• A database system (MySQL, PostgreSQL)
• Node.js and NPM (for compiling assets)

Clone the project repository by running the command below if you use SSH

git clone [email protected]:justbriang/Content-Subscription-Platform.git

If you use https, use this instead

git clone https://github.com/justbriang/Content-Subscription-Platform.git

After cloning,run:

composer install

Duplicate .env.example and rename it .env

Then run:

• setup your environement variable for your database and meilisearch

• Run:

  php artisan key:generate

• Run Database Migrations and Seeders

• Be sure to fill in your database details in your .env file before running the migrations:

  php artisan migrate --seed

• To run tests , execute:

  php artisan test

• And finally, start the application:

  php artisan serve

• visit http://localhost:8000/ to see the application in action.

Alternatively, check out this repo here[https://github.com/justbriang/laravel-docker-local-env] for a template that I use to run laravel application on docker Instructions on how to set it up are on the repository.

##Usage

• Generate API Documentation

  composer require --dev knuckleswtf/scribe

• Publish the config file by running:

  php artisan vendor:publish --tag=scribe-config

• Generate API Documentation

  php artisan scribe:generate
  

• visit http://localhost:8000/docs/index.html/ to see the api documentation in action.

To interact with the API, you can use a tool like Postman. Start by creating a website using the relevant API endpoint. Once the website is created, take note of the returned website ID, as you will use this to create a new post. After creating a post, you can proceed to create a subscription by using the website ID.

After setting up posts and subscriptions, execute the following command to send out notifications to all subscribers:

php artisan app:send-post-notifications