Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
omar-haris committed Oct 19, 2024
1 parent cec1b57 commit 56fe6d7
Show file tree
Hide file tree
Showing 44 changed files with 2,141 additions and 644 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: OpenSeaWave
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/openseawave/keycloak/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/openseawave/keycloak/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/openseawave/keycloak/security/policy
about: Learn how to notify us for sensitive bugs
19 changes: 0 additions & 19 deletions .github/dependabot.yml

This file was deleted.

33 changes: 0 additions & 33 deletions .github/workflows/dependabot-auto-merge.yml

This file was deleted.

28 changes: 0 additions & 28 deletions .github/workflows/phpstan.yml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ phpstan.neon
testbench.yaml
/docs
/coverage
openapi.yaml
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 `keycloak` 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) OpenSeaWave <openseawave.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
66 changes: 22 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,54 @@
# :package_description
# openseawave/keycloak

[![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:
[![Latest Version on Packagist](https://img.shields.io/packagist/v/openseawave/keycloak.svg?style=flat-square)](https://packagist.org/packages/openseawave/keycloak)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/openseawave/keycloak/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/openseawave/keycloak/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/openseawave/keycloak/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/openseawave/keycloak/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/openseawave/keycloak.svg?style=flat-square)](https://packagist.org/packages/openseawave/keycloak)

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.

## Support us

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

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).
The keyclock plugin provides a simple way to integrate Keycloak admin api with full support for Laravel framework.

## Installation

You can install the package via composer:

```bash
composer require :vendor_slug/:package_slug
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan migrate
composer require openseawave/keycloak
```

You can publish the config file with:

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

This is the contents of the published config file:
## Usage

you can use it like this:

```php
return [
];
```
use Openseawave\Keycloak\Keycloak;

Optionally, you can publish the views using
$keycloak = new Keycloak(
baseUrl: 'http://localhost:8080/auth',
username: 'admin',
password: 'admin',
);

```bash
php artisan vendor:publish --tag=":package_slug-views"
$keycloak->getUsers();
```

## Usage
Also you can use it using Laravel Facade:

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
use Openseawave\Keycloak\Facades\Keycloak;
Keycloak::getUsers();
```

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Expand All @@ -85,7 +63,7 @@ Please review [our security policy](../../security/policy) on how to report secu

## Credits

- [:author_name](https://github.com/:author_username)
- [Omar Haris](https://github.com/omar-haris)
- [All Contributors](../../contributors)

## License
Expand Down
45 changes: 25 additions & 20 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "openseawave/keycloak",
"description": "The keyclock plugin provides a simple way to integrate Keycloak admin api with full support for Laravel framework.",
"keywords": [
":vendor_name",
"laravel",
":package_slug"
"openseawave",
"keycloak",
"sso",
"authentication",
"authorization",
"single-sign-on",
"oauth2",
"openid-connect",
"admin",
"api",
"keycloak-api",
"framework",
"laravel"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/openseawave/keycloak",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "[email protected]",
"name": "Omar Haris",
"email": "[email protected]",
"role": "Developer"
}
],
Expand All @@ -23,31 +33,26 @@
"require-dev": {
"laravel/pint": "^1.14",
"nunomaduro/collision": "^8.1.1||^7.10.0",
"larastan/larastan": "^2.9",
"orchestra/testbench": "^9.0.0||^8.22.0",
"pestphp/pest": "^2.34",
"pestphp/pest-plugin-arch": "^2.7",
"pestphp/pest-plugin-laravel": "^2.3",
"phpstan/extension-installer": "^1.3",
"phpstan/phpstan-deprecation-rules": "^1.1",
"phpstan/phpstan-phpunit": "^1.3",
"spatie/laravel-ray": "^1.35"
"pestphp/pest-plugin-laravel": "^2.3"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"OpenSeaWave\\Keycloak\\": "src/",
"OpenSeaWave\\Keycloak\\Database\\Factories\\": "database/factories/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/",
"OpenSeaWave\\Keycloak\\Tests\\": "tests/",
"Workbench\\App\\": "workbench/app/"
}
},
"scripts": {
"post-autoload-dump": "@composer run prepare",
"clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
"clear": "@php vendor/bin/testbench package:purge-keycloak --ansi",
"prepare": "@php vendor/bin/testbench package:discover --ansi",
"build": [
"@composer run prepare",
Expand All @@ -73,10 +78,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"OpenSeaWave\\Keycloak\\KeycloakServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"Keycloak": "OpenSeaWave\\Keycloak\\Facades\\Keycloak"
}
}
},
Expand Down
Loading

0 comments on commit 56fe6d7

Please sign in to comment.