Skip to content

Commit

Permalink
[Chore] Add skel files
Browse files Browse the repository at this point in the history
  • Loading branch information
cmuench committed Dec 17, 2023
1 parent 50e56cf commit 03e4b5d
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 4 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ on:
branches:
- main
- feature/*
# pull_request:
# branches:
# - develop
pull_request:
branches:
- main

permissions:
contents: write
Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.1.0]
### Added

- Initial GraphQL Playground module with /graphiql endpoint
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contribution to MageOS GraphQl Playground

TBD
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Mage-OS Association

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Mage-OS GraphQl Playground

This module is a playground for GraphQl queries and mutations. It is not intended for production use.

The module bundles the graphiql tool which is licensed under the MIT license. See [graphiql/LICENSE](graphiql/LICENSE) for more information.

---

## Installation

1. Install it into your Mage-OS/Magento 2 project with composer:
```
composer require mageos/graphql-playground
```
2. Enable module
```
bin/magento setup:upgrade
```
## Configuration
The GraphQL playground is automatically available in developer mode.
In the production mode it is disabled by default. To enable it in production mode, run:
```bash
bin/magento config:set --lock-env dev/graphiql/enabled_in_production 1
```

In the developer mode the configuration can be set in the adminhtml configuration under `Stores > Configuration > Advanced > Developer > GraphQL Playground`.

## Usage

Open the GraphQL playground in your browser: `https://<your-base-url>/graphiql`


## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Testing

### Unit Tests

In the command line, change into the module directory and run:

```
composer install
./vendor/bin/phpunit
```

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"description": "Provides a GraphQl Playground based on GraphiQL to work with the GraphQl API of Mage-OS",
"type": "magento2-module",
"license": [
"GPL-3.0-only"
"MIT"
],
"repositories": [
{
Expand Down

0 comments on commit 03e4b5d

Please sign in to comment.