Added explanationn to README.md

solanav · Dec 30, 2023 · c30e298 · c30e298
1 parent f070e82
commit c30e298
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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: