{"id":15710785,"url":"https://github.com/datl4g/kromex","last_synced_at":"2025-05-07T08:24:35.913Z","repository":{"id":50672326,"uuid":"372873797","full_name":"DatL4g/Kromex","owner":"DatL4g","description":"Kromex is an extension template written in Kotlin, mainly made for Chrome","archived":false,"fork":false,"pushed_at":"2022-08-01T19:10:34.000Z","size":498,"stargazers_count":52,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T08:07:15.025Z","etag":null,"topics":["brave","brave-extension","chrome","chrome-extension","chrome-extensions","chromium","chromium-extension","firefox","firefox-extension","firefox-extensions","firefox-webextension","kotlin","kotlin-js"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DatL4g.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}},"created_at":"2021-06-01T15:15:28.000Z","updated_at":"2025-03-24T17:33:37.000Z","dependencies_parsed_at":"2022-08-19T19:11:06.701Z","dependency_job_id":null,"html_url":"https://github.com/DatL4g/Kromex","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DatL4g%2FKromex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DatL4g%2FKromex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DatL4g%2FKromex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DatL4g%2FKromex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DatL4g","download_url":"https://codeload.github.com/DatL4g/Kromex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252840491,"owners_count":21812317,"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":["brave","brave-extension","chrome","chrome-extension","chrome-extensions","chromium","chromium-extension","firefox","firefox-extension","firefox-extensions","firefox-webextension","kotlin","kotlin-js"],"created_at":"2024-10-03T21:10:06.845Z","updated_at":"2025-05-07T08:24:35.889Z","avatar_url":"https://github.com/DatL4g.png","language":"Kotlin","funding_links":["https://github.com/sponsors/DATL4G","https://paypal.me/datlag","https://www.patreon.com/datlag"],"categories":[],"sub_categories":[],"readme":"![Kromex Logo](src/main/resources/icons/icon.png)\n\n# Kromex\n\n- Ever wanted to create a Web-Extension with Kotlin-JS?\n- You had no idea where to start or implementation was to difficult?\n\n### Kromex to the rescue!\n\n[![Issues](https://img.shields.io/github/issues/DATL4G/Kromex.svg?style=for-the-badge)](https://github.com/DATL4G/Kromex/issues)\n[![Stars](https://img.shields.io/github/stars/DATL4G/Kromex.svg?style=for-the-badge)](https://github.com/DATL4G/Kromex/stargazers)\n[![Forks](https://img.shields.io/github/forks/DATL4G/Kromex.svg?style=for-the-badge)](https://github.com/DATL4G/Kromex/network/members)\n[![Contributors](https://img.shields.io/github/contributors/DATL4G/Kromex.svg?style=for-the-badge)](https://github.com/DATL4G/Kromex/graphs/contributors)\n[![License](https://img.shields.io/github/license/DATL4G/Kromex.svg?style=for-the-badge)](https://github.com/DATL4G/Kromex/blob/master/LICENSE)\n![Kotlin](https://img.shields.io/badge/kotlin-%230095D5.svg?style=for-the-badge\u0026logo=kotlin\u0026logoColor=white)\n![IntelliJ IDEA](https://img.shields.io/badge/IntelliJIDEA-000000.svg?style=for-the-badge\u0026logo=intellij-idea\u0026logoColor=white)\n\n## Kromex is a Free and Open Source extension template written in Kotlin\n\n- \u003cb\u003eProvides:\u003c/b\u003e popup,content and background out of the box\n- \u003cb\u003eProvides:\u003c/b\u003e base module for extension API implementation\n- \u003cb\u003eProvides:\u003c/b\u003e easy build process\n- \u003cb\u003eUses:\u003c/b\u003e Manifest v3\n- \u003cb\u003eUses:\u003c/b\u003e Kotlin Gradle\n\n## Table of content\n\n- [Getting Started](#getting-started)\n- [Create your extension](#create-your-extension)\n- [Limitations](#limitations)\n  - [Enums](#enums)\n- [Build](#build)\n    - [Generate APIs](#generate-apis)\n    - [Export your extension](#export-your-extension)\n- [Contributing](#contributing)\n    - [Maintainers](#maintainers)\n- [Support the project](#support-the-project)\n\n## Getting Started\n\nFork this repository or click [\u003ckbd\u003eUse this template\u003c/kbd\u003e](https://github.com/DATL4G/Kromex/generate).\n\nImport your new repository into \u003cb\u003eIntelliJ\u003c/b\u003e or any other IDE of your choice.\n\n## Create your extension\n\nI provided all modules you need out of the box and even some small examples.\n\nDo whatever you want with it.\n\n#### Make sure to replace \"Kromex\" with your actual extension name.\n\n## Limitations\n\nIt's possible that the code were not generated correctly in some cases.\nPlease create an issue if you've found any wrong parameter/return type etc.\n\n### Enums\n\nEnums will be generated as well, however if any function/event returns an enum like:\n\n```kotlin\nbrowser.runtime.getPlatformInfo()\n```\n\nThe enum won't be accessible as such.\nInstead, call the ```toString()``` method on it and then create the enum type by this value, e.g.:\n\n```kotlin\nbrowser.runtime.getPlatformInfo().collect {\n    console.log(it.os == PlatformOs.linux)\n    console.log(PlatformOs.valueOf(it.os.toString()) == PlatformOs.linux)\n}\n```\n\nThis will output:\n\n```\nfalse\ntrue\n```\n\n## Build\n\n### Generate APIs\n\nThis is useful e.g. if the API specifications changed.\n\n##### Make sure the previous generated files are deleted\n\n```bash\n./gradlew :generate:clean\n```\n\n##### Generate the files by its specifications\n\n```bash\n./gradlew :generate:run\n```\n\n### Export your extension\n\n##### Rebuild JS files\n\nThis step is not needed if you've edited resource files only.\n\n```bash\n./gradlew clean assemble\n```\n\n##### Copy needed files to /build/extension\n\n```bash\n./gradlew extension\n```\n\n## Contributing\n\nWhen you face any bugs or problems please open an [Issue](https://github.com/DATL4G/BurningSeries-Android/issues/new/choose).\n\nTo add functionality fork the project and create a pull request afterwards. You should know how that works if you are a developer :)\nYou can add yourself to the list below if you want then.\n\n### Maintainers\n\n| Avatar | Contributor |\n|---|:---:|\n| [![](https://avatars3.githubusercontent.com/u/46448715?s=50\u0026v=4)](http://github.com/DatL4g) | [DatLag](http://github.com/DatL4g) |\n\n## Support the project\n\n[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge\u0026logo=GitHub-Sponsors\u0026logoColor=#EA4AAA)](https://github.com/sponsors/DATL4G)\n[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://paypal.me/datlag)\n[![Patreon](https://img.shields.io/badge/Patreon-F96854?style=for-the-badge\u0026logo=patreon\u0026logoColor=white)](https://www.patreon.com/datlag)\n\nSupporting this project helps to keep it up-to-date. You can donate if you want or contribute to the project as well.\nThis shows that the app is used by people and it's worth to maintain.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatl4g%2Fkromex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatl4g%2Fkromex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatl4g%2Fkromex/lists"}