{"id":23547086,"url":"https://github.com/the-events-calendar/ql-events","last_synced_at":"2025-04-24T06:10:41.464Z","repository":{"id":37826926,"uuid":"200128259","full_name":"the-events-calendar/ql-events","owner":"the-events-calendar","description":"The Events Calendar binding to WPGraphQL","archived":false,"fork":false,"pushed_at":"2025-01-16T19:16:44.000Z","size":1117,"stargazers_count":16,"open_issues_count":31,"forks_count":7,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-30T07:41:14.310Z","etag":null,"topics":["graphql","hacktoberfest","php","wordpress"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/the-events-calendar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-01T22:48:23.000Z","updated_at":"2025-01-16T19:16:45.000Z","dependencies_parsed_at":"2025-01-16T20:30:16.741Z","dependency_job_id":"3e225d81-932f-42d8-956a-fab6712d3e53","html_url":"https://github.com/the-events-calendar/ql-events","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-events-calendar%2Fql-events","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-events-calendar%2Fql-events/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-events-calendar%2Fql-events/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-events-calendar%2Fql-events/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/the-events-calendar","download_url":"https://codeload.github.com/the-events-calendar/ql-events/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250573351,"owners_count":21452352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphql","hacktoberfest","php","wordpress"],"created_at":"2024-12-26T09:14:31.485Z","updated_at":"2025-04-24T06:10:41.447Z","avatar_url":"https://github.com/the-events-calendar.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QL Events\n\n[![Automated-Testing](https://github.com/the-events-calendar/ql-events/actions/workflows/tests-php-alt.yml/badge.svg)](https://github.com/the-events-calendar/ql-events/actions/workflows/tests-php-alt.yml) [![Coding-Standards](https://github.com/the-events-calendar/ql-events/actions/workflows/lint.yml/badge.svg)](https://github.com/the-events-calendar/ql-events/actions/workflows/lint.yml)\n\n## Quick Install\n\n1. Install \u0026 activate [The Events Calendar/The Events Calendar Pro](https://theeventscalendar.com/)\n  - (Optional) Install \u0026 activate [Ticket Events/Ticket Events Plus](https://theeventscalendar.com/products/wordpress-event-tickets/)\n2. Install \u0026 activate [WPGraphQL](https://www.wpgraphql.com/)\n  - (Optional) Install \u0026 activate [WPGraphQL-JWT-Authentication](https://github.com/wp-graphql/wp-graphql-jwt-authentication) to add a `login` mutation that returns a JSON Web Token.\n3. Clone or download the zip of this repository into your WordPress plugin directory \u0026 activate the **QL Events** plugin\n\n## What does this plugin do?\n\nIt adds *The Events Calendar*'s and some of it's extension's functionality to the WPGraphQL schema.\n\n## Unit Tests\n\nUntil the documentation is in full effect, it's recommended that a [GraphiQL](https://github.com/graphql/graphiql)-based tool like [WPGraphiQL](https://github.com/wp-graphql/wp-graphiql) be used to view the GraphQL schema, an alternative to this is viewing the unit tests located in `tests/wpunit` directory. Which are constantly updated along with the project. If you're interested in contributing when I begin accepting contribution or simply want to run the tests. Follow the instruction below.\n\n### Prerequisties\n\n- Shell/CMD access\n- [Composer](https://getcomposer.org/)\n- [WP-CLI](https://wp-cli.org/)\n\n### Setup\n\n1. Make sure all dependencies are install by running `composer install` from the CMD/Terminal in the project directory.\n2. Next the copy 5 distributed files with the `.dist` in there filenames. For instance `.env.testing` becomes `.env` and `wpunit.suite.dist.yml` becomes `wpunit.suite.yml`. The distributed files and what their copied names should are as follows.\n    - `codeception.dist.yml` =\u003e `codeception.yml`\n    - `.env.testing` =\u003e `.env`\n3. Next open `.env` and alter to make you usage.\n        ```bash\n    DB_NAME=wordpress\n    DB_HOST=app_db\n    DB_USER=wordpress\n    DB_PASSWORD=wordpress\n    WP_TABLE_PREFIX=wp_\n    WP_URL=http://localhost\n    WP_DOMAIN=localhost\n    ADMIN_EMAIL=admin@example.com\n    ADMIN_USERNAME=admin\n    ADMIN_PASSWORD=password\n    ADMIN_PATH=/wp-admin\n\n    TEST_DB_NAME=ql_events_tests\n    TEST_DB_HOST=127.0.0.1\n    TEST_DB_USER=wordpress\n    TEST_DB_PASSWORD=wordpress\n    TEST_WP_TABLE_PREFIX=wp_\n\n    SKIP_DB_CREATE=false\n    TEST_WP_ROOT_FOLDER=/tmp/wordpress\n    TEST_ADMIN_EMAIL=admin@wp.test\n\n    TESTS_DIR=tests\n    TESTS_OUTPUT=tests/_output\n    TESTS_DATA=tests/_data\n    TESTS_SUPPORT=tests/_support\n    TESTS_ENVS=tests/_envs\n        ```\n    - `Shared` variables are as the comment implies, variables shared in both the `install-wp-tests` script and the **Codeception** configuration. The variable names should tell you what they mean.\n    - `Install script` variables are specified to the `install-wp-tests` script, and most likely won't changed. I've listed their meaning below.\n        - `WP_VERSION` WordPress version used for testing\n        - `SKIP_DB_CREATE` Should database creation be skipped?\n    - `Codeception` variables are specified to the **Codeception** configuration. View the config files and Codeception's [Docs](https://codeception.com/docs/reference/Configuration#Suite-Configuration) for more info on them.\n\n4. Once you have finish modifying the `.env` file. Run `composer install-test-env` from the project directory.\n5. Upon success you can begin running the tests.\n\n### Running tests\nTo run test use the command `vendor/bin/codecept run [suite [test [:test-function]]]`.\nIf you use the command with at least a `suite` specified, **Codeception** will run all tests, however this is not recommended. Running a suite `vendor/bin/codecept run wpunit` or a test `vendor/bin/codecept run VenueQueriesTest` is recommended. Running a single `test-function` like `vendor/bin/codecept run EventQueriesTest:testEventQuery` is also possible.\n\nTo learn more about the usage of Codeception with WordPress view the [Documentation](https://codeception.com/for/wordpress)\n\n### Running tests\nEven though the two suite use a Docker environment to run, the docker environment relies on a few environmental variables defined in `.env` and a volume source provided by the test install script.\n0. Ensure that you can copy `.env.testing` to `.env`.\n1. First you must run `composer install-test-env` to ensure the required dependencies are available.\n2. Next run `composer run-codeception` to run the tests within a docker container.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-events-calendar%2Fql-events","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-events-calendar%2Fql-events","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-events-calendar%2Fql-events/lists"}