Skip to content

Commit 1b85895

Browse files
committed
docs: update support docs
1 parent 04ca33c commit 1b85895

File tree

4 files changed

+391
-29
lines changed

4 files changed

+391
-29
lines changed

introduction.md

Lines changed: 95 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Introduction | Laravel Like
3-
description: Introduction to Laravel Like projects. Get to know the Laravel Like projects. Learn about the Laravel Like projects. Configure and install Laravel Like into your Laravel projects.
4-
keywords: ['laravel like', 'introduction', 'laravel like projects', 'laravel like introduction', 'configure laravel like', 'install laravel like']
5-
tags: ['Introduction', 'Laravel Like', 'Configure', 'Configure laravel like', 'Install laravel like', 'Laravel Like Projects', 'Get Started', 'Laravel Like Introduction', 'Information', 'Laravel Like Information']
3+
description: A comprehensive Laravel package for adding like, dislike, and love interactions to your Eloquent models with ease.
4+
keywords: ['laravel like', 'interactions', 'social features', 'likes', 'dislikes', 'loves', 'laravel package', 'eloquent', 'social engagement']
5+
tags: ['Introduction', 'Features', 'Installation', 'Configuration', 'Usage', 'API', 'Examples', 'Laravel Package']
66
image: /images/laravel-like-docs-thumb.webp
77
---
88

@@ -11,30 +11,106 @@ image: /images/laravel-like-docs-thumb.webp
1111
<meta name="author" content="CSlant" />
1212
</head>
1313

14-
# Introduction
14+
# Laravel Like Package
1515

16-
**_Laravel Like_**.
16+
A powerful and flexible Laravel package that adds social interaction features to your Eloquent models with minimal setup.
1717

18-
A Laravel package to add **interaction functionality** to your Laravel models. It is a simple and easy-to-use package that allows you to add interaction functionality to your **Laravel models**.
18+
![Laravel Like Package](/images/laravel-like-thumb.webp)
1919

20-
<img src="/images/laravel-like-thumb.webp" alt="CSlant Laravel Like Package" class="img-fluid" />
20+
## ✨ Features
2121

22-
Some interactions provided by the package are: **Like, Dislike, Love**.
22+
- **Multiple Interaction Types**: Support for likes, dislikes, and loves out of the box
23+
- **Fully Extensible**: Easily add custom interaction types
24+
- **Efficient Queries**: Optimized database queries for high performance
25+
- **Polymorphic Relationships**: Works with any Eloquent model
26+
- **Flexible Configuration**: Customize table names, model references, and more
27+
- **Comprehensive API**: Simple, intuitive methods for all interaction types
28+
- **Query Scopes**: Powerful filtering and sorting capabilities
29+
- **UUID Support**: Optional UUID support for primary keys
30+
- **Caching**: Built-in caching for better performance
31+
- **Event-Driven**: Fires events for all interactions
2332

24-
The **CSLant Laravel Like** package is not limited to default interactions like "Like," "Dislike," or "Love." This package is designed with high flexibility, allowing you to easily add more types of reactions based on your needs.
33+
## 🚀 Getting Started
2534

26-
You're not restricted to the built-in reactions | you can create and define any type of interaction you prefer.
35+
### Requirements
2736

28-
Additionally, _you can customize the model names and behavior, so you're **not tied to the term "Like."**_
29-
30-
---
37+
- PHP 8.1 or higher
38+
- Laravel 9.0 or higher
39+
- Composer
3140

32-
<p align="center">
33-
<a href="https://github.com/cslant/laravel-like?tab=MIT-1-ov-file"><img src="https://img.shields.io/github/license/cslant/laravel-like.svg?style=flat-square" alt="License" /></a>&nbsp;<a href="https://github.com/cslant/laravel-like/releases"><img src="https://img.shields.io/github/release/cslant/laravel-like.svg?style=flat-square" alt="Latest Version" /></a>&nbsp;<a href="https://packagist.org/packages/cslant/laravel-like"><img src="https://img.shields.io/packagist/dt/cslant/laravel-like.svg?style=flat-square" alt="Total Downloads" /></a>&nbsp;<a href="https://github.com/cslant/laravel-like/actions/workflows/setup_test.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/laravel-like/setup_test.yml?label=tests&branch=main" alt="Test Status" /></a>&nbsp;<a href="https://github.com/cslant/laravel-like/actions/workflows/php-cs-fixer.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/laravel-like/php-cs-fixer.yml?label=code%20style&branch=main" alt="Code Style Status" /></a>&nbsp;<a href="https://scrutinizer-ci.com/g/cslant/laravel-like"><img src="https://img.shields.io/scrutinizer/g/cslant/laravel-like.svg?style=flat-square" alt="Quality Score" /></a>
34-
</p>
41+
### Installation
42+
43+
1. Install the package via Composer:
44+
45+
```bash
46+
composer require cslant/laravel-like
47+
```
48+
49+
2. Publish the configuration file and migrations:
50+
51+
```bash
52+
php artisan vendor:publish --provider="CSlant\LaravelLike\Providers\LikeServiceProvider"
53+
```
54+
55+
3. Run the migrations:
56+
57+
```bash
58+
php artisan migrate
59+
```
60+
61+
## 🔧 Configuration
62+
63+
The package comes with sensible defaults, but you can customize its behavior by modifying the `config/like.php` file. Key configuration options include:
64+
65+
- `is_uuids`: Use UUIDs instead of auto-incrementing IDs
66+
- `table_name`: Customize the interactions table name
67+
- `interaction_model`: Specify a custom interaction model
68+
- `users.model`: Configure the user model
69+
- `users.foreign_key`: Set the user foreign key
3570

36-
## 📝 Information
71+
## 📚 Documentation
3772

38-
- [Installation](getting-started/installation)
39-
- [Configuration](getting-started/configuration)
73+
Explore the comprehensive documentation to get the most out of Laravel Like:
74+
75+
- [Basic Usage](usage/liking_content.md) - Learn how to add interactions to your models
76+
- [Checking Interactions](usage/check_if_interacted.md) - Determine if users have interacted with content
77+
- [Counting Interactions](usage/counting_interactions.md) - Get interaction counts and statistics
78+
- [Query Scopes](usage/query_scopes.md) - Filter and sort content by interaction data
79+
- [Advanced Usage](usage/advanced_usage.md) - Custom interaction types and advanced features
80+
81+
## 🤝 Contributing
82+
83+
Contributions are welcome! Please see our [contributing guide](https://github.com/cslant/laravel-like/blob/main/CONTRIBUTING.md) for details.
84+
85+
## 📄 License
86+
87+
This package is open-sourced software licensed under the [MIT License](https://opensource.org/licenses/MIT).
88+
89+
## 🔗 Links
90+
91+
- [GitHub Repository](https://github.com/cslant/laravel-like)
92+
- [Issues](https://github.com/cslant/laravel-like/issues)
4093
- [Changelog](prologue/releases)
94+
95+
## 📊 Stats
96+
97+
<p align="center">
98+
<a href="https://github.com/cslant/laravel-like?tab=MIT-1-ov-file">
99+
<img src="https://img.shields.io/github/license/cslant/laravel-like.svg?style=flat-square" alt="License" />
100+
</a>
101+
<a href="https://github.com/cslant/laravel-like/releases">
102+
<img src="https://img.shields.io/github/release/cslant/laravel-like.svg?style=flat-square" alt="Latest Version" />
103+
</a>
104+
<a href="https://packagist.org/packages/cslant/laravel-like">
105+
<img src="https://img.shields.io/packagist/dt/cslant/laravel-like.svg?style=flat-square" alt="Total Downloads" />
106+
</a>
107+
<a href="https://github.com/cslant/laravel-like/actions/workflows/setup_test.yml">
108+
<img src="https://img.shields.io/github/actions/workflow/status/cslant/laravel-like/setup_test.yml?label=tests&branch=main" alt="Test Status" />
109+
</a>
110+
<a href="https://github.com/cslant/laravel-like/actions/workflows/php-cs-fixer.yml">
111+
<img src="https://img.shields.io/github/actions/workflow/status/cslant/laravel-like/php-cs-fixer.yml?label=code%20style&branch=main" alt="Code Style Status" />
112+
</a>
113+
<a href="https://scrutinizer-ci.com/g/cslant/laravel-like">
114+
<img src="https://img.shields.io/scrutinizer/g/cslant/laravel-like.svg?style=flat-square" alt="Quality Score" />
115+
</a>
116+
</p>

support/feature-requests.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Feature Requests | Laravel Like
3-
description: Request new features for the Laravel Like projects. Request new features for the Laravel Like projects. Get the list of all feature requests available in the Laravel Like projects.
4-
keywords: ['laravel like', 'feature requests', 'new features', 'request new features', 'feature requests for laravel like']
5-
tags: ['Feature Requests', 'New features', 'Requests', 'Laravel Like Feature', 'Support']
3+
description: Request new features for the Laravel Like package. Get the list of all feature requests available in the Laravel Like package.
4+
keywords: ['laravel like', 'feature requests', 'new features', 'request new features', 'feature requests for Laravel Like']
5+
tags: ['Feature Requests', 'New features', 'Requests', 'Laravel Like Feature', 'Support', 'features']
66
---
77

88
<head>
@@ -12,5 +12,37 @@ tags: ['Feature Requests', 'New features', 'Requests', 'Laravel Like Feature', '
1212

1313
# 🔥 Feature Requests
1414

15-
If you have any feature requests, please open an issue with the `feature request` label on
16-
the [GitHub repository](https://github.com/cslant/laravel-like/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=).
15+
We welcome and appreciate all feature requests from our community. Before submitting a new feature request, please check the existing [issues](https://github.com/cslant/laravel-like/issues) to see if it has already been requested.
16+
17+
## How to Request a Feature
18+
19+
1. **Check Existing Issues**
20+
- Search the [GitHub issues](https://github.com/cslant/laravel-like/issues) to see if your feature has already been requested.
21+
- Look at the [milestones](https://github.com/cslant/laravel-like/milestones) to see planned features.
22+
23+
2. **Create a New Issue**
24+
- Go to [New Issue](https://github.com/cslant/laravel-like/issues/new/choose)
25+
- Select "Feature Request"
26+
- Fill in the template with as much detail as possible
27+
28+
## What Makes a Good Feature Request?
29+
30+
- **Clear Description**: Explain what you want to achieve and why it's valuable
31+
- **Use Case**: Describe the problem you're trying to solve
32+
- **Examples**: Provide code examples or mockups if applicable
33+
- **Alternatives**: Mention any alternative solutions you've considered
34+
35+
## Feature Request Process
36+
37+
1. **Discussion**: The community and maintainers will discuss the feature
38+
2. **Approval**: If accepted, it will be added to a milestone
39+
3. **Implementation**: The feature will be developed and tested
40+
4. **Release**: Included in the next release
41+
42+
## Currently Planned Features
43+
44+
Check our [project board](https://github.com/orgs/cslant/projects/2) to see what features are currently being worked on.
45+
46+
## Contributing
47+
48+
If you'd like to implement a feature yourself, please read our [Contributing Guide](https://github.com/cslant/laravel-like/blob/main/CONTRIBUTING.md) first.

support/issues.md

Lines changed: 67 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Issues | Laravel Like
3-
description: Issues and bug reports for the Laravel Like projects. Report issues and bugs for the Laravel Like projects. Get the list of all issues available in the Laravel Like projects.
4-
keywords: ['laravel like', 'issues', 'bug reports', 'report issues', 'issues for laravel like']
3+
description: Issues and bug reports for the Laravel Like package. Report issues and bugs for the Laravel Like package. Get the list of all issues available in the Laravel Like package.
4+
keywords: ['laravel like', 'issues', 'bug reports', 'report issues', 'issues for Laravel Like']
55
tags: ['Issues', 'Bug reports', 'Report issues', 'Laravel Like Issues', 'Laravel Like Bug Reports', 'Support']
66
---
77

@@ -10,8 +10,70 @@ tags: ['Issues', 'Bug reports', 'Report issues', 'Laravel Like Issues', 'Laravel
1010
<meta name="author" content="CSlant" />
1111
</head>
1212

13-
# 📢 Issues
13+
# 📢 Reporting Issues
1414

15-
If you find yourself stuck using this package, found a bug, or have a feature request. Please open an issue on [GitHub](https://github.com/cslant/laravel-like/issues).
15+
We appreciate you taking the time to report issues with the Laravel Like package. Your feedback helps us improve the package for everyone.
1616

17-
We appreciate detailed and accurate reports that help us identify and replicate the issue.
17+
## Before You Report
18+
19+
1. **Search Existing Issues**
20+
- Check if the issue has already been reported on our [GitHub Issues](https://github.com/cslant/laravel-like/issues) page.
21+
- Look at the [closed issues](https://github.com/cslant/laravel-like/issues?q=is%3Aissue+is%3Aclosed) as well, as your issue might have been resolved.
22+
23+
2. **Check the Documentation**
24+
- Review the [documentation](https://docs.cslant.com/laravel-like) to ensure you're using the package correctly.
25+
- Check the [FAQ](#frequently-asked-questions) section below for common issues.
26+
27+
## How to Report an Issue
28+
29+
1. **Create a New Issue**
30+
- Go to [New Issue](https://github.com/cslant/laravel-like/issues/new/choose)
31+
- Select "Bug Report"
32+
- Fill in the template with as much detail as possible
33+
34+
2. **Required Information**
35+
- Laravel version
36+
- Package version
37+
- PHP version
38+
- Steps to reproduce the issue
39+
- Expected behavior
40+
- Actual behavior
41+
- Any relevant error messages or logs
42+
43+
## Writing a Good Bug Report
44+
45+
A good bug report includes:
46+
47+
- **Clear Title**: Briefly describe the issue
48+
- **Detailed Description**: Explain what you're trying to do
49+
- **Reproduction Steps**: Step-by-step instructions to reproduce the issue
50+
- **Code Examples**: Relevant code snippets that demonstrate the issue
51+
- **Error Messages**: Include any error messages or stack traces
52+
- **Screenshots**: If applicable, add screenshots to help explain the problem
53+
54+
## Issue Triage Process
55+
56+
1. **Initial Review**: A maintainer will review your issue
57+
2. **Needs More Info**: If more information is needed, we'll ask for it
58+
3. **Reproduction**: We'll try to reproduce the issue
59+
4. **Prioritization**: The issue will be prioritized based on severity and impact
60+
5. **Resolution**: The issue will be fixed in an upcoming release
61+
62+
## Frequently Asked Questions
63+
64+
### Why was my issue closed?
65+
66+
Issues might be closed if:
67+
- They are duplicates of existing issues
68+
- They don't follow the issue template
69+
- They lack sufficient information to reproduce
70+
- They are not related to the package
71+
72+
### How can I speed up the resolution of my issue?
73+
- Provide a clear, minimal reproduction
74+
- Be responsive to requests for more information
75+
- If possible, submit a pull request with a fix
76+
77+
## Security Issues
78+
79+
If you discover a security vulnerability within Laravel Like, please email [[email protected]](mailto:[email protected]) instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

0 commit comments

Comments
 (0)