From c30e2987b3ef2e5da23be75c238bbeb1d8c434e6 Mon Sep 17 00:00:00 2001 From: asolana Date: Sat, 30 Dec 2023 17:27:19 +0100 Subject: [PATCH] Added explanationn to README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6379712..7ded1a2 100644 --- a/README.md +++ b/README.md @@ -108,10 +108,14 @@ PhishFlood will launch a Playwright browser instance in the background and start ### Running the API +To start the API and all required componets (RabbitMQ, PostgreSQL and the workers) you can run: + ```bash docker compose -f docker/docker-compose.yml up --build ``` +The API will be running in `localhost:8000` and you can start exploring the different endpoints through the web UI. + ## Testing We use [pytest](https://docs.pytest.org/en/stable/) for testing. To run the tests, use the following command: