Jelajahi Sumber

update readme

Harry de Boer 5 tahun lalu
induk
melakukan
3f94547450
1 mengubah file dengan 14 tambahan dan 5 penghapusan
  1. 14 5
      README.md

+ 14 - 5
README.md

@@ -1,6 +1,6 @@
 # Simple calculator
 
-This calculator project contains a simple Angular based frontend a Spring based backend.
+This calculator project contains a simple Angular based frontend, and a Spring based backend.
 
 ## Environment
 
@@ -21,15 +21,24 @@ operations in the frontend and use HATEOAS links instead. The latter is not impl
 
 ### Compiling and running
 
-Navigate into the `backend` directory and run `mvn spring-boot:run`
+Navigate into the `backend` directory and run `mvn spring-boot:run`.
+Integration and unittests can be run using `mvn verify`. 
 
 ### Example api call
 
-Navigate to `http://localhost:8080/numbers/5/add/15` in a browser and observe the response.
+Navigate to ` http://localhost:8080/numbers/5/add/15 ` in a browser and observe the response.
 
 ## Frontend
 
 ### Compiling and running
 
-Navigate to the `frontend` directory and run `ng serve`
-To access the UI navigate to `http://localhost:4200/` with a browser. 
+Make sure the backend is started first.
+Navigate to the `frontend` directory and run `npm install` followed by `ng serve`
+To access the UI navigate to ` http://localhost:4200/ ` with a browser.
+Unittests can be run using `ng test`.
+Integration test can be run using `ng e2e`
+
+## Author
+Harry de Boer
+
+email: hdboer@quintor.nl