laravel-blog-using-jetstream

Laravel Blog Project

Overview

This is a blog application built with Laravel 10, integrating powerful tools such as Filament, Livewire, and Jetstream. The project aims to provide a robust and scalable platform for creating and managing blog posts with a user-friendly interface and real-time features.

Table of Contents

• Features
• Requirements
• Installation
• Usage
• Testing
• Deployment
• Contribution
• License

Features

• User Authentication: Secure authentication powered by Jetstream.
• Admin Panel: Manage blog posts, categories, and users through an intuitive admin panel with Filament.
• Real-Time Updates: Dynamic and interactive components utilizing Livewire for a seamless user experience.
• Blog Management: Create, update, delete, and publish blog posts.
• Category Management: Organize blog posts into categories for easy navigation.
• User Roles and Permissions: Role-based access control for different user types (admin, editor, viewer).

Requirements

• PHP 8.1 or higher
• Composer
• Node.js & npm
• MySQL or any other supported database

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/laravel-blog-using-jetstream.git
   cd laravel-blog-using-jetstream

2. Install dependencies:

   composer install
   npm install

3. Set up environment variables:

   • Copy .env.example to .env:

     cp .env.example .env

   • Update the .env file with your database credentials and other environment settings.

4. Generate application key:

   php artisan key:generate

5. Run migrations:

   php artisan migrate

6. Install and configure Jetstream:

   php artisan jetstream:install livewire

7. Build assets:

   npm run build

8. Seed the database (optional):

   php artisan db:seed

9. Serve the application:

   php artisan serve

Usage

• Admin Panel: Accessible at /admin, where you can manage posts, categories, and users.
• Blog Frontend: The blog can be viewed at the root URL. Visitors can browse posts by category and search for content.
• User Authentication: Users can register, log in, and manage their profiles using Jetstream's authentication features.

Testing

Run the automated tests to ensure that everything is working as expected:

php artisan test

For continuous integration, the build status and coverage are tracked using GitHub Actions and Coveralls.

Deployment

For deploying this application to a production server, ensure you have properly set up your environment variables, configured your web server, and optimized your application:

php artisan optimize

Consider using services like Laravel Forge for easy server management and deployment.

Contribution

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

Please ensure your code follows the PSR-12 coding standard and includes relevant tests.

License

This project is open-sourced software licensed under the MIT license.