README

📝 Turahe Post

A powerful Laravel package for managing posts with rich content, markdown support, and comprehensive testing.

🚀 Quick Start

composer require turahe/post

📦 Installation

Step 1: Install Package

composer require turahe/post

Step 2: Publish Resources

php artisan vendor:publish --provider="Turahe\Post\PostServiceProvider"

Step 3: Run Migrations

php artisan migrate

Step 4: Done! 🎉

Your post management system is ready to use.

✨ Features

🚀 Quick Start

📝 Basic Usage

use Turahe\Post\Models\Post;

// Create a post
$post = Post::create([
    'title' => 'My First Post',
    'subtitle' => 'A subtitle',
    'description' => 'Post description',
    'type' => 'post',
]);

// Add content with markdown
$post->setContents('# Hello World\n\nThis is **markdown** content.');

// Get formatted content
echo $post->content; // HTML output
echo $post->content_raw; // Raw markdown

📊 Content Management

// Get the latest content
$content = $post->getContent();

// Get word count and read time
echo $content->word_count; // Number of words
echo $content->read_time['text']; // "2 minutes"

📢 Publishing Posts

// Publish a post
$post->update(['published_at' => now()]);

// Get published posts
$published = Post::published()->get();

// Get draft posts
$drafts = Post::notPublished()->get();

🤝 Contributing

We welcome contributions! Please ensure:

📋 Requirements

• ✅ Code Quality: Run composer check before submitting
• ✅ Test Coverage: Maintain or improve test coverage
• ✅ Documentation: Update documentation as needed

🧪 Testing Guidelines

• Write tests for new features
• Ensure existing tests pass
• Aim for 90%+ code coverage
• Test both happy path and edge cases

📊 Coverage Requirements

• New Features: Must have 90%+ coverage
• Bug Fixes: Must include regression tests
• Refactoring: Must maintain existing coverage levels

📈 Coverage Reports

For detailed coverage analysis, see:

• 📄 COVERAGE_REPORT.md - Comprehensive coverage analysis
• 🌐 coverage/index.html - Visual HTML report
• 📊 coverage.xml - XML data for CI/CD

🛠️ Development

🧪 Testing

# Run the test suite
composer test

# Run tests with coverage
composer test-coverage

🎨 Code Quality

# Check code style
composer pint-test

# Fix code style issues
composer pint

# Run all quality checks (code style + tests)
composer check

📊 Code Coverage

# Run tests with coverage analysis
$env:XDEBUG_MODE="coverage"; composer test-coverage

📈 Current Coverage: 46% overall (23/50 statements)

📋 Requirements

🔄 CI/CD

This package uses GitHub Actions for continuous integration and deployment.

🧪 Continuous Integration

🚀 Automatic Releases

🔄 Automated Triggers

• ✅ Push to master or main branches
• ✅ Pull requests to master or main branches
• ✅ Tag pushes (triggers automatic release)

📊 Code Coverage Status

📈 Overall Coverage: 46% (23/50 statements)

🎯 Coverage Goals

📄 License

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

🆘 Support

📋 Changelog

🚀 v1.2.0 (Latest)

📝 v1.1.0

🎉 v1.0.0