Ux for new developers

README.md

@@ -16,6 +16,9 @@ and [building easy-to-read messages ready to be sent to the scanned organization
 
 If you want to use additional modules that weren't included here due to non-BSD-compatible licenses, browse to the [Artemis-modules-extra](https://github.com/CERT-Polska/Artemis-modules-extra) repository.
 
+If you work as a developer and you want to modify code, you have to do some modifications ⮕  **[Developers](#develop)**
+
+
 **Artemis is experimental software, under active development - use at your own risk.**
 
 To chat about Artemis, join the Discord server:
@@ -43,9 +46,16 @@ The possibility to automatically prepare such reports enabled us to notify entit
 ## Screenshots
 ![Artemis - scan](.github/screenshots/scan.png)
 
+<a name="develop"></a>
 ## Development
-If you want to develop Artemis, remember to change the [Docker Compose file](https://github.com/CERT-Polska/Artemis/blob/main/docker-compose.yaml#L7) so that
+If you want to develop Artemis, remember to change the Docker Compose file in two places. 
+- **[First modification](https://github.com/CERT-Polska/Artemis/blob/main/docker-compose.yaml#L7)** so that
 the Artemis image is built locally (from the code you are changing) not downloaded from Docker Hub.
+- **[Second modification](https://github.com/CERT-Polska/Artemis/blob/main/docker-compose.yaml#L100)** to do
+modifications on the local machine.
+
+To provide reloading entire web app you have to use **[cmd command](https://github.com/CERT-Polska/Artemis/blob/main/docker/Dockerfile#L30)** with *"--reload"* option. 
+You will be able to see the results of code modifications on the page without reloading the entire container.
 
 ### Tests
 To run the tests, use:

docker-compose.yaml

@@ -5,8 +5,8 @@ x-artemis-build-or-image:
   # not one downloaded from Docker Hub:
   #
   # build:
-  #    context: .
-  #    dockerfile: docker/Dockerfile
+  #  context: .
+  #  dockerfile: docker/Dockerfile
 
 services:
   redis:
@@ -97,6 +97,8 @@ services:
     ports: ["5000:5000"]
     restart: always
     volumes:
+      # Add new volume to modify local Artemis source code to see changes on website.
+      # - ./:/opt
       - data-web:/data
       - ./docker/karton.ini:/etc/karton/karton.ini:ro
       - ./output/autoreporter/:/opt/output/autoreporter

docker/Dockerfile

@@ -26,4 +26,6 @@ COPY "artemis/" "artemis/"
 COPY "static/" "static/"
 COPY "templates/" "templates/"
 
+# Add "--reload" option to see changes on website without reloading web container.
+# CMD ["uvicorn", "artemis.main:app", "--host", "0.0.0.0", "--port", "5000", "--reload"]
 CMD ["uvicorn", "artemis.main:app", "--host", "0.0.0.0", "--port", "5000"]