FirmwareDroid Client

FirmwareDroid is an analysis tool for Android firmware. This repository contains the FirmwareDroid frontend implementation with React.

Contribution

Feel free to contribute and open pull requests.

As a first step, follow the Getting Started guide to install FirmwareDroid.

If you have successfully set up FirmwareDroid, please stop and remove its containers.

docker compose down

Next, please open directory /FirmwareDroid and uncomment the following line in file docker-compose.yml.

cd FirmwareDroid

- ./firmware-droid-client/build:/usr/share/nginx/html # Dev-Route

Optionally, fork repository https://github.com/FirmwareDroid/FMD-WebClient, delete directory /firmware-droid-client and clone your forked repository. Note that the web frontend directory needs to be called firmware-droid-client.

rm -rf firmware-droid-client

git clone https://github.com/<username-with-fork>/FMD-WebClient firmware-droid-client

Then, open directory /firmware-droid-client and install the web frontend's dependencies and build it.

cd firmware-droid-client

yarn install && yarn build

And then switch back to directory /FirmwareDroid and create and start the containers again.

docker compose up

At this point, verify that the web frontend is running at https://fmd.localhost.

If it is running, you are set to make changes to the frontend's source code in /firmware-droid-client. To apply your changes build the project again.

yarn build

Finally, if you refresh the page you should see your changes.