Skip to content

Commit 2df3c6c

Browse files
authored
Chore/docs improve (#47)
* docs: update README.md to enhance clarity and structure of filtering engines and usage examples * docs: remove outdated get-started.md as it no longer reflects current setup instructions * docs: correct class reference in usage example for Expression Engine * docs: enhance lifecycle hooks documentation for clarity and examples * docs: update annotation documentation for clarity, structure, and additional details * docs: add documentation for creating and testing custom annotations in the Invokable Engine * chore: update dependencies in package.json - Upgraded @vuepress/bundler-vite from ^2.0.0-rc.7 to ^2.0.0-rc.26 - Upgraded @vuepress/theme-default from ^2.0.0-rc.11 to ^2.0.0-rc.125 - Upgraded sass-embedded from ^1.80.3 to ^1.98.0 - Added typescript as a devDependency with version ^5.9.3 - Upgraded vuepress from ^2.0.0-rc.7 to ^2.0.0-rc.26 - Added vuepress-theme-plume as a new devDependency with version ^1.0.0-rc.192 - Replaced dependencies: - Removed @vuepress/plugin-active-header-links, execa, tsparticles, and vue3-particles - Added gsap, ogl, postprocessing, and three with specified versions * docs: update service provider documentation with enhanced title, description, and tags * docs: update composer.json with enhanced description and keywords for clarity * docs: enhance documentation with improved titles, descriptions, and structure across multiple files * docs: update README.md with enhanced title, description, and features section for clarity * feat: update VuePress configuration to use plumeTheme and enhance SEO metadata * Add tsparticles and vue3-particles dependencies to package.json * docs: enhance event system documentation with new sections on API reference, best practices, use cases, and exception handling * docs: enhance authorization and exception handling documentation with improved descriptions and tags
1 parent 841c377 commit 2df3c6c

42 files changed

Lines changed: 10940 additions & 4876 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

composer.json

Lines changed: 57 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,60 @@
11
{
2-
"name": "kettasoft/filterable",
3-
"description": "Easy and fast Eloquent filter package",
4-
"type": "library",
5-
"license": "MIT",
6-
"keywords": [
7-
"laravel",
8-
"eloquent",
9-
"search",
10-
"model",
11-
"query",
12-
"filter"
13-
],
14-
"autoload": {
15-
"psr-4": {
16-
"Kettasoft\\Filterable\\": "src/",
17-
"Kettasoft\\Filterable\\Database\\Migrations\\": "database/migrations/"
2+
"name": "kettasoft/filterable",
3+
"description": "A powerful Laravel package for advanced Eloquent query filtering using dedicated filter classes, multiple engines, and clean HTTP request mapping.",
4+
"type": "library",
5+
"license": "MIT",
6+
"keywords": [
7+
"laravel",
8+
"eloquent",
9+
"eloquent-filter",
10+
"filterable",
11+
"filter",
12+
"filtering",
13+
"query-filter",
14+
"api-filter",
15+
"request-filter",
16+
"search"
17+
],
18+
"autoload": {
19+
"psr-4": {
20+
"Kettasoft\\Filterable\\": "src/",
21+
"Kettasoft\\Filterable\\Database\\Migrations\\": "database/migrations/"
22+
},
23+
"files": [
24+
"src/Support/helpers.php"
25+
]
1826
},
19-
"files": [
20-
"src/Support/helpers.php"
21-
]
22-
},
23-
"autoload-dev": {
24-
"psr-4": {
25-
"Kettasoft\\Filterable\\Tests\\": "tests/"
26-
}
27-
},
28-
"authors": [
29-
{
30-
"name": "Abdalrhman Emad Saad",
31-
"email": "kettasoft@gmail.com"
32-
}
33-
],
34-
"require": {
35-
"php": "^8.0",
36-
"illuminate/database": "^10.0|^11.0|^12.0",
37-
"illuminate/support": "^10.0|^11.0|^12.0",
38-
"opis/closure": "^4.3"
39-
},
40-
"require-dev": {
41-
"mockery/mockery": "^1.3.2",
42-
"orchestra/testbench": "10.8",
43-
"phpunit/phpunit": "^11.5"
44-
},
45-
"scripts": {
46-
"test": "php vendor/bin/phpunit"
47-
},
48-
"extra": {
49-
"version": "1.0.0",
50-
"laravel": {
51-
"providers": []
52-
}
53-
},
54-
"minimum-stability": "dev",
55-
"prefer-stable": true
27+
"autoload-dev": {
28+
"psr-4": {
29+
"Kettasoft\\Filterable\\Tests\\": "tests/"
30+
}
31+
},
32+
"authors": [
33+
{
34+
"name": "Abdalrhman Emad Saad",
35+
"email": "kettasoft@gmail.com"
36+
}
37+
],
38+
"require": {
39+
"php": "^8.0",
40+
"illuminate/database": "^10.0|^11.0|^12.0",
41+
"illuminate/support": "^10.0|^11.0|^12.0",
42+
"opis/closure": "^4.3"
43+
},
44+
"require-dev": {
45+
"mockery/mockery": "^1.3.2",
46+
"orchestra/testbench": "10.8",
47+
"phpunit/phpunit": "^11.5"
48+
},
49+
"scripts": {
50+
"test": "php vendor/bin/phpunit"
51+
},
52+
"extra": {
53+
"version": "1.0.0",
54+
"laravel": {
55+
"providers": []
56+
}
57+
},
58+
"minimum-stability": "dev",
59+
"prefer-stable": true
5660
}

docs/.vuepress/client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { defineClientConfig } from "@vuepress/client";
22
import Particles from "vue3-particles";
33
import ParticlesBackground from "./components/ParticlesBackground.vue";
4-
4+
import "./styles/index.scss";
55
export default defineClientConfig({
66
enhance({ app }) {
77
app.use(Particles);

0 commit comments

Comments
 (0)