{"id":20930072,"url":"https://github.com/level-level/ll-voordemensen","last_synced_at":"2025-05-13T18:32:41.302Z","repository":{"id":40675649,"uuid":"306063159","full_name":"level-level/ll-voordemensen","owner":"level-level","description":"Access the VoordeMensen ticket platform directly from within WordPress","archived":false,"fork":false,"pushed_at":"2025-02-04T14:17:39.000Z","size":740,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-02T06:35:43.310Z","etag":null,"topics":[],"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/level-level.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2020-10-21T15:08:36.000Z","updated_at":"2025-02-04T14:14:22.000Z","dependencies_parsed_at":"2023-12-28T09:25:14.940Z","dependency_job_id":"56be1d9c-b689-4deb-80e4-f2e34a8a238d","html_url":"https://github.com/level-level/ll-voordemensen","commit_stats":{"total_commits":258,"total_committers":6,"mean_commits":43.0,"dds":0.1589147286821705,"last_synced_commit":"a43fd1cd67326f809cc3301015d48eeaed8efcf4"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/level-level%2Fll-voordemensen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/level-level%2Fll-voordemensen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/level-level%2Fll-voordemensen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/level-level%2Fll-voordemensen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/level-level","download_url":"https://codeload.github.com/level-level/ll-voordemensen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254003428,"owners_count":21997886,"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":[],"created_at":"2024-11-18T21:28:42.105Z","updated_at":"2025-05-13T18:32:41.288Z","avatar_url":"https://github.com/level-level.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GitHub Actions status](https://github.com/level-level/ll-voordemensen/workflows/Build%20%26%20test/badge.svg)](https://github.com/level-level/ll-voordemensen/actions)\n\n# VoordeMensen (ll-voordemensen)\nUnofficial plugin to access the VoordeMensen ticket platform directly from WordPress\n\n## ⚠️ Abandoned\nThis package has been abandoned because none of our customers use this plugin anymore.\nInstead, VoordeMensen has [their own plugin](https://wordpress.org/plugins/voordemensen/) available in the WordPress plugin repository.\nYou can also download it with Composer by [requiring it from WPackagist](https://wpackagist.org/search?q=voordemensen).\n\n## Installation\n### Zip download (recommended)\nTo download and install this plugin in your WordPress website, follow the steps below:\n\n1. Go to the [releases tab](https://github.com/level-level/ll-voordemensen/releases) and find the latest release.\n2. Download the zip named `ll-voordemensen-x.x.x.zip` (where x.x.x is the version number).\n3. Rename the downloaded zip to `ll-voordemensen.zip`.\n4. Extract the zip file. Make sure it puts the contents in a directory called `ll-voordemensen`.\n5. Put the extracted folder and it's contents inside the `wp-content/plugins` directory of your WordPress installation.\n6. Activate the plugin via the wp-admin panel.\n\n### Composer installation (alternative method)\nIt's also possible to download the plugin via Packagist.\nKeep in mind that if you do, your composer should be setup in a way that packages of the type `wordpress-plugin` are installed in your `wp-content/plugins` directory.\n\n## Configuration\nTo configure the plugin, just fill in your client name in the VoordeMensen plugin settings screen.\n\n## Development\n### Setup\n1. Create a new WordPress installation using the latest twenty-* theme.\n2. Navigate to the `wp-content/plugins` directory.\n3. Clone this repo there, so it creates the `ll-voordemensen` directory.\n4. Navigate to the `ll-voordemensen` directory, and from there, run:\n\n```bash\ncomposer-install\nnpm ci\nnpm run build\n```\n\nRun `composer run test` to verify results locally (more info about tests later in this file).\n\n### Releasing\n1. Merge all PR's in the `main` branch.\n2. Change the version number in `ll-voordemensen.php`.\n3. Wait for all GitHub Actions to finish.\n4. Update the created draft release, set a tag and version name, in SEMVER structure like vX.X.X.\n5. Publish the release.\n\n### Composer\nComposer is used to manage the autoloading and automatic testing. More on the testing subject can be found later in this document.\n\n### Webpack\n#### Usage\n  - `npm run start`\n  - `npm run lint`\n  - `npm run fix`\n  - `npm run build`\n  - `npm run scripts:lint`\n  - `npm run scripts:fix`\n  - `npm run styles:lint`\n  - `npm run styles:fix`\n  - `npm run browsersync`\n  - `npm run bundle-analyzer`\n\nIf you run into any problems locally with the initial installation of the node_modules (especially webpack) try setting your local environment to DEV by executing the following on your CLI:\n\n```bash\nexport NODE_ENV=development\n```\n\nThe cause of the problem is probably the Node version and the default state it's in (it used to install all packages, but recently changed to production modules only).\n\n#### Config\nUsing custom config for webpack dev server. Duplicate the `development/config.local.json.example` file and save it as `development/config.local.json`. In this file you add your own project url, set secure based on your dev protocol and set a port. This config is being used to overwrite the default URL of your local dev environment. This applies to the webpack-dev-server and browser-sync.\n\nExample:\n```json\n{\n  \"url\": \"http://local.my-site.test\",\n  \"secure\": false,\n  \"port\": 1234\n}\n```\n\n#### Images\nWebpack automatically processes images used in the SCSS. For the images that you use directly in php, import them into `index.js`.\n\n```javascript\nimport 'images/logo.jpg';\n```\n\nGet the image URL in the .php files by using the `( new \\LevelLevel\\VoorDeMensen\\Assets() )-\u003eget_assets_directory_url()` function.\nFor example placing a logo in the header:\n```html\n\u003cimg src=\"\u003c?php echo ( new \\LevelLevel\\VoorDeMensen\\Assets() )-\u003eget_assets_directory_url(); ?\u003e/images/logo.jpg\" alt=\"\"\u003e\n```\n\n##### Lazyload\nWe use default browser lazyloading for images.\nUsage example:\n```html\n\u003cimg src=\"\u003c?php echo ( new \\LevelLevel\\VoorDeMensen\\Assets() )-\u003eget_assets_directory_url(); ?\u003e/images/thumbnail.jpg\" loading=\"lazy\" alt=\"\"\u003e\n```\n\n#### Linter\n- Styleint: Styleint is used, rules are set in `.stylelintrc.json`. View all [doc rules](https://stylelint.io/user-guide/rules/list)\n- JS: eslint is used, rules are set in `.eslintrc.json`. View all [doc rules](https://eslint.org/docs/rules/)\n\n### Localization\nDefault text language for this repo is English.\nMake sure you translate all strings with the text-domain `ll-vdm`.\n\nRun: `composer run make-pot` for updating the .pot file.\n\n### Automated testing\nThere are multiple code tests in place.\n- Composer, to check if the composer files are intact\n- PHPCS, to check if you are following the Level Level PHP code standards\n- Psalm tests, that searches for possible mistakes in your code\n- PHP Doc Check, to check if complicated functions have comments explaining the functionality\n\n#### GitHub actions\nOn every pull-request, a GitHub action is run that verifies the project, based on the\n`composer run test` results. You need to provide the following secret in the\nrepository (under settings/secrets):\n\n- SATIS_DOMAIN (without protocol)\n- SATIS_USERNAME\n- SATIS_PASSWORD\n\n#### Manually\n\nRun `composer run test` to verify results locally.\n\n#### Fixing\n\nRun `composer run fix` to use automated fixing tools such as phpcbf.\n\n### Working locally with https\n\nIf you locally work with https you need to enable Chrome to allow invalid certificates. To enable this go to: `chrome://flags/#allow-insecure-localhost` and enable the `Allow invalid certificates for resources loaded from localhost.` option.\n\n### Editor config\nTheme comes with a .editorconfig file. For this to work you need to install a plugin that uses the `.editorconfig` file.\n- [Visual Code Studio](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)\n- [Atom](https://atom.io/packages/editorconfig)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevel-level%2Fll-voordemensen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flevel-level%2Fll-voordemensen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevel-level%2Fll-voordemensen/lists"}