diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f19dfc2d4..232196e11 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,21 +4,20 @@ about: Create a report to help us improve title: '' labels: Bug assignees: '' - --- **Platform** Which platform does the bug apply to? -* WebExtension (Google Chrome, Mozilla Firefox) -* NPM -* Bookmarklet -* Website + +- WebExtension (Google Chrome, Mozilla Firefox) +- Website **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '...' 3. Scroll down to '...' diff --git a/.github/workflows/submit.yml b/.github/workflows/submit.yml deleted file mode 100644 index 4bc3ef514..000000000 --- a/.github/workflows/submit.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: "submit" -on: - workflow_dispatch: - -permissions: - contents: read - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Download Github Release Assets - uses: PlasmoHQ/download-release-asset@v1.0.0 - with: - files: webextension.zip - - name: Browser Plugin Publish - uses: PlasmoHQ/bpp@v2 - with: - artifact: webextension.zip - keys: ${{ secrets.SUBMIT_KEYS }} diff --git a/.gitignore b/.gitignore index 3d8b66509..97f83b858 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,7 @@ /build/* -/src/drivers/**/categories.json -/src/drivers/**/technologies/* -/src/drivers/**/wappalyzer.js -/src/drivers/webextension/images/icons/converted/* -/src/drivers/webextension/manifest.json -/src/drivers/webextension/manifest.bak.json +/src/images/icons/converted/* +/src/manifest.json +/src/manifest.bak.json node_modules package-lock.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68de51289..561c402b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,17 +8,17 @@ To get started, see the [README](https://github.com/wappalyzer/wappalyzer/blob/m ## Submitting changes -- First, run `yarn run validate` to identify any issues. -- Use descriptive commit messages, e.g. 'Add WordPress detection'. -- Push your commits to a new branch on your own fork. -- Finally, submit a [pull request](https://help.github.com/articles/about-pull-requests/) and describe your changes. +- First, run `yarn run validate` to identify any issues. +- Use descriptive commit messages, e.g. 'Add WordPress detection'. +- Push your commits to a new branch on your own fork. +- Finally, submit a [pull request](https://help.github.com/articles/about-pull-requests/) and describe your changes. ## Adding a new technology Wappalyzer uses [regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) to fingerprint technologies. Refer to the [specification](https://github.com/wappalyzer/wappalyzer/blob/master/README.md#specification) for detail. -- Add a new block to [`src/technologies/*.json`](https://github.com/wappalyzer/wappalyzer/blob/master/src/technologies). The filename should match the first letter of the technology name (a-z). Use `_.json` if the first character is a number or symbol. -- Add an icon to [`src/drivers/webextension/images/icons`](https://github.com/wappalyzer/wappalyzer/tree/master/src/drivers/webextension/images/icons). The image must be square, either SVG or PNG (32 x 32 pixels). +- Add a new block to [`src/technologies/*.json`](https://github.com/wappalyzer/wappalyzer/blob/master/src/technologies). The filename should match the first letter of the technology name (a-z). Use `_.json` if the first character is a number or symbol. +- Add an icon to [`src/images/icons`](https://github.com/wappalyzer/wappalyzer/tree/master/src/images/icons). The image must be square, either SVG or PNG (32 x 32 pixels). Only widely used technologies are accepted. When creating a pull request, include ten or more links to websites that use the application, a GitHub page with at least 1,000 stars or anything that will help establish the size of the user base. @@ -26,11 +26,11 @@ Only widely used technologies are accepted. When creating a pull request, includ Please [open an issue on GitHub](https://github.com/wappalyzer/wappalyzer/issues) first to discuss the need for a new category. -To add a category, edit [`src/categories.json`](https://github.com/wappalyzer/wappalyzer/blob/master/src/categories.json) and update every [locale](https://github.com/wappalyzer/wappalyzer/tree/master/src/drivers/webextension/_locales). You may use the English category name in all of them. +To add a category, edit [`src/categories.json`](https://github.com/wappalyzer/wappalyzer/blob/master/src/categories.json) and update every [locale](https://github.com/wappalyzer/wappalyzer/tree/master/src/_locales). You may use the English category name in all of them. ## Adding a new translation -To add a new translation, copy the `en` folder in [`src/drivers/webextension/_locales`](https://github.com/wappalyzer/wappalyzer/tree/master/src/drivers/webextension/_locales), rename it to the relevant two-letter country code and update the containing `messages.json` file. +To add a new translation, copy the `en` folder in [`src/_locales`](https://github.com/wappalyzer/wappalyzer/tree/master/src/_locales), rename it to the relevant two-letter country code and update the containing `messages.json` file. ## Adding a new feature diff --git a/README.md b/README.md index 4b70d36b0..e307ddf9d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ [![Validate](https://github.com/wappalyzer/wappalyzer/actions/workflows/validate.yml/badge.svg)](https://github.com/wappalyzer/wappalyzer/actions/workflows/validate.yml) -[![wappalyzer NPM](https://img.shields.io/badge/npm-wappalyzer-blue)](https://www.npmjs.com/package/wappalyzer) -[![wappalyzer-core NPM](https://img.shields.io/badge/npm-wappalyzer--core-blue)](https://www.npmjs.com/package/wappalyzer-core) [![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=https://github.com/sponsors/AliasIO)](https://github.com/sponsors/AliasIO) Wappalyzer @@ -11,13 +9,11 @@ **[Wappalyzer](https://www.wappalyzer.com) identifies technologies on websites, such as CMS, web frameworks, ecommerce platforms, JavaScript libraries, analytics tools and [more](https://www.wappalyzer.com/technologies).** -If you don't have time to configure, host, debug and maintain your own infrastructure to analyse websites at scale, we offer a SaaS solution that has all the same capabilities and a lot more. Our [apps](https://www.wappalyzer.com/apps/) and [APIs](https://www.wappalyzer.com/api/) not only reveal the technology stack a website uses but also company and contact details, social media profiles, keywords and metadata. - ## Prerequisites -- [Git](https://git-scm.com) -- [Node.js](https://nodejs.org) version 14 or higher -- [Yarn](https://yarnpkg.com) +- [Git](https://git-scm.com) +- [Node.js](https://nodejs.org) version 14 or higher +- [Yarn](https://yarnpkg.com) ## Quick start @@ -25,29 +21,22 @@ If you don't have time to configure, host, debug and maintain your own infrastru git clone https://github.com/wappalyzer/wappalyzer.git cd wappalyzer yarn install -yarn run link ``` ## Usage -### Command line - -```sh -node src/drivers/npm/cli.js https://example.com -``` - ### Chrome extension -* Go to `about:extensions` -* Enable 'Developer mode' -* Click 'Load unpacked' -* Select `src/drivers/webextension` +- Go to `about:extensions` +- Enable 'Developer mode' +- Click 'Load unpacked' +- Select `src` ### Firefox extension -* Go to `about:debugging#/runtime/this-firefox` -* Click 'Load Temporary Add-on' -* Select `src/drivers/webextension/manifest.json` +- Go to `about:debugging#/runtime/this-firefox` +- Click 'Load Temporary Add-on' +- Select `src/manifest.json` ## Specification @@ -208,6 +197,7 @@ Find the JSON schema at [`schema.json`](https://github.com/wappalyzer/wappalyzer Cost indicator (based on a typical plan or average monthly price) and available pricing models. For paid products only. One of: + Plus any of: +