|
1 |
| -# :package_description |
| 1 | +# laravel-json-structure |
2 | 2 |
|
3 |
| -[](https://packagist.org/packages/:vendor_slug/:package_slug) |
4 |
| -[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain) |
5 |
| -[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) |
6 |
| -[](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: |
| 3 | +[](https://packagist.org/packages/hyperlink/laravel-json-structure) |
| 4 | +[](https://github.com/hyperlinkgroup/laravel-json-structure/actions?query=workflow%3Arun-tests+branch%3Amain) |
| 5 | +[](https://packagist.org/packages/hyperlink/laravel-json-structure) |
10 | 6 |
|
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. |
18 |
| - |
19 |
| -## Support us |
20 |
| - |
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) |
22 |
| - |
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). |
24 |
| - |
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). |
| 7 | +A helper package for the assert json structure test method. It will create a json structure as needed from an api endpoint of your application. |
26 | 8 |
|
27 | 9 | ## Installation
|
28 | 10 |
|
29 | 11 | You can install the package via composer:
|
30 | 12 |
|
31 | 13 | ```bash
|
32 |
| -composer require :vendor_slug/:package_slug |
33 |
| -``` |
34 |
| - |
35 |
| -You can publish and run the migrations with: |
36 |
| - |
37 |
| -```bash |
38 |
| -php artisan vendor:publish --tag=":package_slug-migrations" |
39 |
| -php artisan migrate |
40 |
| -``` |
41 |
| - |
42 |
| -You can publish the config file with: |
43 |
| - |
44 |
| -```bash |
45 |
| -php artisan vendor:publish --tag=":package_slug-config" |
46 |
| -``` |
47 |
| - |
48 |
| -This is the contents of the published config file: |
49 |
| - |
50 |
| -```php |
51 |
| -return [ |
52 |
| -]; |
53 |
| -``` |
54 |
| - |
55 |
| -Optionally, you can publish the views using |
56 |
| - |
57 |
| -```bash |
58 |
| -php artisan vendor:publish --tag=":package_slug-views" |
| 14 | +composer require hyperlink/laravel-json-structure |
59 | 15 | ```
|
60 | 16 |
|
61 | 17 | ## Usage
|
62 | 18 |
|
63 | 19 | ```php
|
64 |
| -$variable = new VendorName\Skeleton(); |
65 |
| -echo $variable->echoPhrase('Hello, VendorName!'); |
| 20 | +$jsonStructure = new Hyperlink\JsonStructure(); |
| 21 | +echo $jsonStructure->echoPhrase('Hello, Hyperlink!'); |
66 | 22 | ```
|
67 | 23 |
|
68 |
| -## Testing |
69 |
| - |
70 |
| -```bash |
71 |
| -composer test |
72 |
| -``` |
73 |
| - |
74 |
| -## Changelog |
75 |
| - |
76 |
| -Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. |
77 |
| - |
78 |
| -## Contributing |
79 |
| - |
80 |
| -Please see [CONTRIBUTING](CONTRIBUTING.md) for details. |
81 |
| - |
82 |
| -## Security Vulnerabilities |
83 |
| - |
84 |
| -Please review [our security policy](../../security/policy) on how to report security vulnerabilities. |
85 |
| - |
86 | 24 | ## Credits
|
87 | 25 |
|
88 |
| -- [:author_name](https://github.com/:author_username) |
89 |
| -- [All Contributors](../../contributors) |
| 26 | +- [Katalam](https://github.com/Katalam) |
90 | 27 |
|
91 | 28 | ## License
|
92 | 29 |
|
|
0 commit comments