Developer Documentation
Notice:
These documents are meant for developers.
Before you continue
Have a look at the Setup Guide in the root README and set up a development environment.
Files
This project is divided into multiple directories.
| Path | Purpose |
|---|---|
| /docs | This directory |
| /.github | Files for Github Integration (Issue Templates, Workflows, …) |
| /build | Contains scripts called by npm (build, test, lint) |
| /content_scripts | The scripts injected into faceit.com and report.ecl.gg according to manifest.json. |
| /form | The UI that is used to ask for additional information from the user. Written in Vue. |
| /background | Contains the message broker that proxies messages between the form and the content_script |
| /dist | Contains the build made by running npm run build:[prod|dev] in the root of this repo. How to install the builds |
Note that npm will generate the node_modules directories during setup, it contains all dependencies.
Diagram
