Skip to content

Commit 7ba97be

Browse files
committed
Initial commit
1 parent 348d36f commit 7ba97be

23 files changed

+393
-294
lines changed

Diff for: .github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: :vendor_name
1+
github: ziming

Diff for: .github/ISSUE_TEMPLATE/config.yml

+3-3
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_slug/discussions/new?category=q-a
4+
url: https://github.com/ziming/laravel-scrapingbee/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_slug/discussions/new?category=ideas
7+
url: https://github.com/ziming/laravel-scrapingbee/discussions/new?category=ideas
88
about: Share ideas for new features
99
- name: Report a bug
10-
url: https://github.com/vendor_slug/package_slug/issues/new
10+
url: https://github.com/ziming/laravel-scrapingbee/issues/new
1111
about: Report a reproducable bug

Diff for: .github/SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Security Policy
22

3-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
3+
If you discover any security related issues, please email me instead of using the issue tracker.

Diff for: CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Changelog
22

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

5-
## 1.0.0 - 202X-XX-XX
5+
## 0.1.0 - 2021-08-21
66

77
- initial release

Diff for: LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) :vendor_name <[email protected]>
3+
Copyright (c) ziming
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

Diff for: README.md

+14-36
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,40 @@
1-
# :package_description
1+
# A PHP Laravel Library for ScrapingBee
22

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/workflow/status/vendor_slug/package_slug/run-tests?label=tests)](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/workflow/status/vendor_slug/package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+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)
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/ziming/laravel-scrapingbee.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-scrapingbee)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/ziming/laravel-scrapingbee/run-tests?label=tests)](https://github.com/ziming/laravel-scrapingbee/actions?query=workflow%3Arun-tests+branch%3Amain)
5+
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/ziming/laravel-scrapingbee/Check%20&%20fix%20styling?label=code%20style)](https://github.com/ziming/laravel-scrapingbee/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
6+
[![Total Downloads](https://img.shields.io/packagist/dt/ziming/laravel-scrapingbee.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-scrapingbee)
77

8-
---
9-
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
10-
11-
1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
12-
2. Run "./configure-skeleton.sh" to run a script that will replace all placeholders throughout all the files
13-
3. Remove this block of text.
14-
4. Have fun creating your package.
15-
5. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
16-
---
17-
18-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
19-
20-
## Support us
21-
22-
[<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)
23-
24-
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).
25-
26-
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).
8+
A PHP Laravel Package for ScrapingBee
279

2810
## Installation
2911

3012
You can install the package via composer:
3113

3214
```bash
33-
composer require vendor_slug/package_slug
34-
```
35-
36-
You can publish and run the migrations with:
37-
38-
```bash
39-
php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-migrations"
40-
php artisan migrate
15+
composer require ziming/laravel-scrapingbee
4116
```
4217

4318
You can publish the config file with:
4419
```bash
45-
php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-config"
20+
php artisan vendor:publish --provider="Ziming\LaravelScrapingBee\LaravelScrapingBeeServiceProvider" --tag="laravel-scrapingbee-config"
4621
```
4722

4823
This is the contents of the published config file:
4924

5025
```php
5126
return [
27+
'api_key' => env('SCRAPINGBEE_API_KEY'),
28+
'base_url' => env('SCRAPINGBEE_BASE_URL', 'https://app.scrapingbee.com/api/v1/'),
5229
];
5330
```
5431

5532
## Usage
5633

5734
```php
58-
$skeleton = new VendorName\Skeleton();
59-
echo $skeleton->echoPhrase('Hello, Spatie!');
35+
$scrapingBeeClient = Ziming\LaravelScrapingBee::make();
36+
37+
// Look at the source code of `src/LaravelScrapingBee.php` for now. Proper Docs will be added later.
6038
```
6139

6240
## Testing
@@ -79,7 +57,7 @@ Please review [our security policy](../../security/policy) on how to report secu
7957

8058
## Credits
8159

82-
- [:author_name](https://github.com/:author_username)
60+
- [Ziming](https://github.com/ziming)
8361
- [All Contributors](../../contributors)
8462

8563
## License

Diff for: composer.json

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
{
2-
"name": "vendor_slug/package_slug",
3-
"description": ":package_description",
2+
"name": "ziming/laravel-scrapingbee",
3+
"description": "A PHP Laravel Library for ScrapingBee",
44
"keywords": [
5-
":vendor_name",
5+
"ziming",
66
"laravel",
7-
"package_slug"
7+
"laravel-scrapingbee"
88
],
9-
"homepage": "https://github.com/vendor_slug/package_slug",
9+
"homepage": "https://github.com/ziming/laravel-scrapingbee",
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": {
@@ -30,13 +30,13 @@
3030
},
3131
"autoload": {
3232
"psr-4": {
33-
"VendorName\\Skeleton\\": "src",
34-
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
33+
"Ziming\\LaravelScrapingBee\\": "src",
34+
"Ziming\\LaravelScrapingBee\\Database\\Factories\\": "database/factories"
3535
}
3636
},
3737
"autoload-dev": {
3838
"psr-4": {
39-
"VendorName\\Skeleton\\Tests\\": "tests"
39+
"Ziming\\LaravelScrapingBee\\Tests\\": "tests"
4040
}
4141
},
4242
"scripts": {
@@ -50,10 +50,10 @@
5050
"extra": {
5151
"laravel": {
5252
"providers": [
53-
"VendorName\\Skeleton\\SkeletonServiceProvider"
53+
"Ziming\\LaravelScrapingBee\\LaravelScrapingBeeServiceProvider"
5454
],
5555
"aliases": {
56-
"Skeleton": "VendorName\\Skeleton\\SkeletonFacade"
56+
"LaravelScrapingBee": "Ziming\\LaravelScrapingBee\\LaravelScrapingBeeFacade"
5757
}
5858
}
5959
},

Diff for: config/scrapingbee.php

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?php
2+
3+
return [
4+
'api_key' => env('SCRAPINGBEE_API_KEY'),
5+
'base_url' => env('SCRAPINGBEE_BASE_URL', 'https://app.scrapingbee.com/api/v1/'),
6+
];

Diff for: config/skeleton.php

-5
This file was deleted.

Diff for: configure-skeleton.sh

-138
This file was deleted.

Diff for: database/factories/ModelFactory.php

-19
This file was deleted.

Diff for: database/migrations/create_skeleton_table.php.stub

-19
This file was deleted.

Diff for: phpunit.xml.dist

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
verbose="true"
2020
>
2121
<testsuites>
22-
<testsuite name="VendorName Test Suite">
22+
<testsuite name="Ziming Test Suite">
2323
<directory>tests</directory>
2424
</testsuite>
2525
</testsuites>

Diff for: resources/views/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)