Skip to content
This repository has been archived by the owner on Sep 8, 2022. It is now read-only.

Latest commit

 

History

History
106 lines (76 loc) · 4.23 KB

README.md

File metadata and controls

106 lines (76 loc) · 4.23 KB
Raw



ECL Report Addon

Logo

codecov
codecov Travis Build
Mergify Dependabot
Contributor Covenant GitHub Maintainability

Discontinued

I am now working on the official ECL 2.0 Web Extension. The new addon includes parts of this addon's functionality and adds tons of more features. Check it out on ECL's GitLab.

What is this?

ECL is a matchmaking organizer for Counter-Strike: Global Offensive. Their games are hosted and managed by Faceit. In order to report misbehaving players ECL made their own report tool. Unfortunately a lot of information must be copied over, like a link to the match room, the link to the reported player and so on. This discourages players from reporting others and gives room for toxic players. The goal of this extension is to offer a clean and fast way to report players and making the ECL experience a bit better.

For users

Did you discover something strange or want to request a new feature? PM me on twitter or write me an email or even better: open an issue.



For Developers

If you want to contribute to this project make sure you read the CODE OF CONDUCT and are familiar with How to contribute to open source. Read the CONTRIBUTING.md.

Building

  1. Make sure you have npm installed
  2. Clone this repo: git clone [email protected]:FoseFx/ECL-Report-Addon.git
  3. Install Dependencies npm run setup
  4. Build the extension for development using npm run build:dev
  5. Build the extension for production using npm run build:prod
  6. Install the build

Testing

In order to be merged your code must be tested. This project uses the jest test runner.

Run npm test to run all tests and to generate a coverage report (open using firefox coverage/lconv-report/index.html)

Run npm run e2e[:nobuild] to run all End to End tests. This requires docker to be installed and firefox and google-chrome to exist in yor path. Because we cant run chrome in headless mode a display is needed.

If you dont have a display connected install Xvfb and run npm run e2e:nox or npm run e2e:nobuild-nox.

Linting

Code style and readability is important! Use npm run lint to check if your code is compliant, if not try npm run lint:fix and/or manually fix it.

Install build

Firefox

  1. Navigate to about:addons.
  2. Click on the wheel
  3. Click debug addon
  4. Click load temporary addon

Chrome

  1. Navigate to chrome://extensions/.
  2. Activate developer mode in the upper right corner
  3. Click load unpacked