0xb00b5/firegex-traffic-viewer
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Domingo Dirutigliano
2023-10-01 02:21:07 +02:00
parent 661fedae39
commit 9995595a55
5 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -25,7 +25,7 @@ By default firegex will start in a multithread configuration using the number of
The default port of firegex is 4444. At the startup you will choose a password, that is essential for your security. The default port of firegex is 4444. At the startup you will choose a password, that is essential for your security.
All the configuration at the startup is customizable in [firegex.py](./start.py) or directly in the firegex interface. All the configuration at the startup is customizable in [firegex.py](./start.py) or directly in the firegex interface.
![Firegex Network scheme](docs/Firegex_Screenshot.jpg) ![Firegex Network scheme](docs/Firegex_Screenshot.png)
## Functionalities ## Functionalities

BIN
docs/FiregexInternals.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 139 KiB

BIN
docs/Firegex_Screenshot.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 85 KiB

BIN
docs/Firegex_Screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 364 KiB

6
frontend/README.md
View File

@@ -1,11 +1,11 @@
# Firegex Frontend # Firegex Frontend
![Firegex Frontend](../docs/Firegex_Screenshot.jpg) ![Firegex Frontend](../docs/Firegex_Screenshot.png)
The frontend of firegex is written using create-react-app. The frontend of firegex is written using vite.
The routing of the pages is managed by react-router 6 and the graphics is mainly managed by the framework [Mantine](https://mantine.dev) and icons provided by [React Icons](https://react-icons.github.io/react-icons/). The routing of the pages is managed by react-router 6 and the graphics is mainly managed by the framework [Mantine](https://mantine.dev) and icons provided by [React Icons](https://react-icons.github.io/react-icons/).
The style of the page is written with [sass](https://sass-lang.com/). The style of the page is written with [sass](https://sass-lang.com/).
The page is auto-updated by a global timeout and also thanks to socket.io that raise an event triggering all parts of the app that requires fetch updated data from the backend, the update of these data. The page is auto-updated by a global timeout and also thanks to socket.io that raise an event triggering all parts of the app that requires fetch updated data from the backend, the update of these data.
## [GO BACK](../README.md) ## [GO BACK](../README.md)