Skip to content

Commit bc47342

Browse files
committed
Initial version
1 parent 6c4b404 commit bc47342

25 files changed

+297
-554
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: :vendor_name
1+
github: ziming

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Ask a question
4-
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=q-a
4+
url: https://github.com/ziming/laravel-docparser/discussions/new?category=q-a
55
about: Ask the community for help
66
- name: Request a feature
7-
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas
7+
url: https://github.com/ziming/laravel-docparser/discussions/new?category=ideas
88
about: Share ideas for new features
99
- name: Report a security issue
10-
url: https://github.com/:vendor_slug/:package_name/security/policy
10+
url: https://github.com/ziming/laravel-docparser/security/policy
1111
about: Learn how to notify us for sensitive bugs

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Changelog
22

3-
All notable changes to `:package_name` will be documented in this file.
3+
All notable changes to `laravel-docparser` will be documented in this file.

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) :vendor_name <author@domain.com>
3+
Copyright (c) ziming <[email protected].com>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 33 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,64 @@
1-
# :package_description
2-
3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
5-
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
6-
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
7-
<!--delete-->
8-
---
9-
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
10-
11-
1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
12-
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
13-
3. Have fun creating your package.
14-
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
15-
---
16-
<!--/delete-->
17-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
1+
# Laravel package for Docparser
182

19-
## Support us
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/ziming/laravel-docparser.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-docparser)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ziming/laravel-docparser/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ziming/laravel-docparser/actions?query=workflow%3Arun-tests+branch%3Amain)
5+
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ziming/laravel-docparser/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ziming/laravel-docparser/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
6+
[![Total Downloads](https://img.shields.io/packagist/dt/ziming/laravel-docparser.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-docparser)
207

21-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
8+
Laravel Package for [Docparser](https://docparser.com/?ref=iavng). An awesome and user friendly document parser SaaS.
229

23-
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
2410

25-
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
2611

27-
## Installation
12+
## Support us
2813

29-
You can install the package via composer:
14+
You can support me by becoming a customer of Docparser through my referral link:
3015

31-
```bash
32-
composer require :vendor_slug/:package_slug
33-
```
16+
[Docparser](https://docparser.com/?ref=iavng)
17+
18+
## Installation
3419

35-
You can publish and run the migrations with:
20+
You can install the package via composer:
3621

3722
```bash
38-
php artisan vendor:publish --tag=":package_slug-migrations"
39-
php artisan migrate
23+
composer require ziming/laravel-docparser
4024
```
4125

4226
You can publish the config file with:
4327

4428
```bash
45-
php artisan vendor:publish --tag=":package_slug-config"
29+
php artisan vendor:publish --tag="laravel-docparser-config"
4630
```
4731

4832
This is the contents of the published config file:
4933

5034
```php
5135
return [
36+
'base_url' => env('DOCPARSER_BASE_URL', 'https://api.docparser.com/'),
37+
'api_key' => env('DOCPARSER_API_KEY'),
5238
];
5339
```
5440

55-
Optionally, you can publish the views using
56-
57-
```bash
58-
php artisan vendor:publish --tag=":package_slug-views"
59-
```
60-
6141
## Usage
6242

6343
```php
64-
$variable = new VendorName\Skeleton();
65-
echo $variable->echoPhrase('Hello, VendorName!');
44+
$docparser = new Ziming\LaravelDocparser::make();
45+
echo $docparser->pingV1Api();
6646
```
6747

48+
Look at the source code of `src/LaravelDocparser.php` for more methods (link below):
49+
50+
[LaravelDocparser.php](https://github.com/ziming/laravel-docparser/blob/main/src/LaravelDocparser.php)
51+
52+
To learn more about what each method does in more detail, please refer to the [Docparser API documentation](https://docparser.com/api/?iavng).
53+
54+
## Other Resources to Get Started
55+
To learn more about Docparser, I recommend the following resources:
56+
57+
- [Docparser Features](https://docparser.com/features?ref=iavng)
58+
- [Docparser Pricing](https://docparser.com/pricing?ref=iavng)
59+
- [Docparser Blog on Extracting Data from PDF](https://docparser.com/blog/extract-data-from-pdf/?ref=iavng)
60+
- [Docparser Blog on Zonal OCR](https://docparser.com/blog/zonal-ocr/?ref=iavng)
61+
6862
## Testing
6963

7064
```bash
@@ -85,7 +79,7 @@ Please review [our security policy](../../security/policy) on how to report secu
8579

8680
## Credits
8781

88-
- [:author_name](https://github.com/:author_username)
82+
- [ziming](https://github.com/ziming)
8983
- [All Contributors](../../contributors)
9084

9185
## License

composer.json

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,46 @@
11
{
2-
"name": ":vendor_slug/:package_slug",
3-
"description": ":package_description",
2+
"name": "ziming/laravel-docparser",
3+
"description": "Laravel package for Docparser",
44
"keywords": [
5-
":vendor_name",
5+
"ziming",
66
"laravel",
7-
":package_slug"
7+
"laravel-docparser"
88
],
9-
"homepage": "https://github.com/:vendor_slug/:package_slug",
9+
"homepage": "https://github.com/ziming/laravel-docparser",
1010
"license": "MIT",
1111
"authors": [
1212
{
13-
"name": ":author_name",
14-
"email": "author@domain.com",
15-
"role": "Developer"
13+
"name": "ziming",
14+
"email": "ziming.opensource@gmail.com",
15+
"role": "Package Uploader"
1616
}
1717
],
1818
"require": {
19-
"php": "^8.4",
19+
"php": "^8.3",
2020
"spatie/laravel-package-tools": "^1.16",
2121
"illuminate/contracts": "^10.0||^11.0"
2222
},
2323
"require-dev": {
2424
"laravel/pint": "^1.14",
2525
"nunomaduro/collision": "^8.1.1||^7.10.0",
26-
"larastan/larastan": "^2.9",
26+
"larastan/larastan": "^3.0",
2727
"orchestra/testbench": "^9.0.0||^8.22.0",
2828
"pestphp/pest": "^3.0",
2929
"pestphp/pest-plugin-arch": "^3.0",
3030
"pestphp/pest-plugin-laravel": "^3.0",
3131
"phpstan/extension-installer": "^1.3",
32-
"phpstan/phpstan-deprecation-rules": "^1.1",
33-
"phpstan/phpstan-phpunit": "^1.3",
32+
"phpstan/phpstan-deprecation-rules": "^2.0",
33+
"phpstan/phpstan-phpunit": "^2.0",
3434
"spatie/laravel-ray": "^1.35"
3535
},
3636
"autoload": {
3737
"psr-4": {
38-
"VendorName\\Skeleton\\": "src/",
39-
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
38+
"Ziming\\LaravelDocparser\\": "src/"
4039
}
4140
},
4241
"autoload-dev": {
4342
"psr-4": {
44-
"VendorName\\Skeleton\\Tests\\": "tests/",
43+
"Ziming\\LaravelDocparser\\Tests\\": "tests/",
4544
"Workbench\\App\\": "workbench/app/"
4645
}
4746
},
@@ -63,10 +62,10 @@
6362
"extra": {
6463
"laravel": {
6564
"providers": [
66-
"VendorName\\Skeleton\\SkeletonServiceProvider"
65+
"Ziming\\LaravelDocparser\\LaravelDocparserServiceProvider"
6766
],
6867
"aliases": {
69-
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
68+
"LaravelDocparser": "Ziming\\LaravelDocparser\\Facades\\LaravelDocparser"
7069
}
7170
}
7271
},

config/docparser.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
// config for Ziming/LaravelDocparser
6+
return [
7+
'base_url' => env('DOCPARSER_BASE_URL', 'https://api.docparser.com/'),
8+
'api_key' => env('DOCPARSER_API_KEY'),
9+
];

config/skeleton.php

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)