Skip to content

Commit

Permalink
Initial version
Browse files Browse the repository at this point in the history
  • Loading branch information
ziming committed Feb 3, 2025
1 parent 6c4b404 commit bc47342
Show file tree
Hide file tree
Showing 25 changed files with 297 additions and 554 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: :vendor_name
github: ziming
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=q-a
url: https://github.com/ziming/laravel-docparser/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas
url: https://github.com/ziming/laravel-docparser/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/:vendor_slug/:package_name/security/policy
url: https://github.com/ziming/laravel-docparser/security/policy
about: Learn how to notify us for sensitive bugs
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `laravel-docparser` will be documented in this file.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

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

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
72 changes: 33 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,64 @@
# :package_description

[![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)
[![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)
[![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)
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
<!--delete-->
---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
---
<!--/delete-->
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
# Laravel package for Docparser

## Support us
[![Latest Version on Packagist](https://img.shields.io/packagist/v/ziming/laravel-docparser.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-docparser)
[![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)
[![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)
[![Total Downloads](https://img.shields.io/packagist/dt/ziming/laravel-docparser.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-docparser)

[<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)
Laravel Package for [Docparser](https://docparser.com/?ref=iavng). An awesome and user friendly document parser SaaS.

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).

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).

## Installation
## Support us

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

```bash
composer require :vendor_slug/:package_slug
```
[Docparser](https://docparser.com/?ref=iavng)

## Installation

You can publish and run the migrations with:
You can install the package via composer:

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan migrate
composer require ziming/laravel-docparser
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag=":package_slug-config"
php artisan vendor:publish --tag="laravel-docparser-config"
```

This is the contents of the published config file:

```php
return [
'base_url' => env('DOCPARSER_BASE_URL', 'https://api.docparser.com/'),
'api_key' => env('DOCPARSER_API_KEY'),
];
```

Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag=":package_slug-views"
```

## Usage

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
$docparser = new Ziming\LaravelDocparser::make();
echo $docparser->pingV1Api();
```

Look at the source code of `src/LaravelDocparser.php` for more methods (link below):

[LaravelDocparser.php](https://github.com/ziming/laravel-docparser/blob/main/src/LaravelDocparser.php)

To learn more about what each method does in more detail, please refer to the [Docparser API documentation](https://docparser.com/api/?iavng).

## Other Resources to Get Started
To learn more about Docparser, I recommend the following resources:

- [Docparser Features](https://docparser.com/features?ref=iavng)
- [Docparser Pricing](https://docparser.com/pricing?ref=iavng)
- [Docparser Blog on Extracting Data from PDF](https://docparser.com/blog/extract-data-from-pdf/?ref=iavng)
- [Docparser Blog on Zonal OCR](https://docparser.com/blog/zonal-ocr/?ref=iavng)

## Testing

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

## Credits

- [:author_name](https://github.com/:author_username)
- [ziming](https://github.com/ziming)
- [All Contributors](../../contributors)

## License
Expand Down
33 changes: 16 additions & 17 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,47 +1,46 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "ziming/laravel-docparser",
"description": "Laravel package for Docparser",
"keywords": [
":vendor_name",
"ziming",
"laravel",
":package_slug"
"laravel-docparser"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/ziming/laravel-docparser",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"role": "Developer"
"name": "ziming",
"email": "ziming.opensource@gmail.com",
"role": "Package Uploader"
}
],
"require": {
"php": "^8.4",
"php": "^8.3",
"spatie/laravel-package-tools": "^1.16",
"illuminate/contracts": "^10.0||^11.0"
},
"require-dev": {
"laravel/pint": "^1.14",
"nunomaduro/collision": "^8.1.1||^7.10.0",
"larastan/larastan": "^2.9",
"larastan/larastan": "^3.0",
"orchestra/testbench": "^9.0.0||^8.22.0",
"pestphp/pest": "^3.0",
"pestphp/pest-plugin-arch": "^3.0",
"pestphp/pest-plugin-laravel": "^3.0",
"phpstan/extension-installer": "^1.3",
"phpstan/phpstan-deprecation-rules": "^1.1",
"phpstan/phpstan-phpunit": "^1.3",
"phpstan/phpstan-deprecation-rules": "^2.0",
"phpstan/phpstan-phpunit": "^2.0",
"spatie/laravel-ray": "^1.35"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"Ziming\\LaravelDocparser\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/",
"Ziming\\LaravelDocparser\\Tests\\": "tests/",
"Workbench\\App\\": "workbench/app/"
}
},
Expand All @@ -63,10 +62,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Ziming\\LaravelDocparser\\LaravelDocparserServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"LaravelDocparser": "Ziming\\LaravelDocparser\\Facades\\LaravelDocparser"
}
}
},
Expand Down
9 changes: 9 additions & 0 deletions config/docparser.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

declare(strict_types=1);

// config for Ziming/LaravelDocparser
return [
'base_url' => env('DOCPARSER_BASE_URL', 'https://api.docparser.com/'),
'api_key' => env('DOCPARSER_API_KEY'),
];
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

Loading

0 comments on commit bc47342

Please sign in to comment.