rfac: docs

Makefile

@@ -17,7 +17,7 @@ buildProducerDevImage:
 buildClientDevImage: get
 	@docker build -t autocd-client -f ./src/client/Dockerfile.dev ./src/client/
 
-runProducerDevContainer: runProducerDevContainer
+runProducerDevContainer: buildProducerDevImage
 	@docker run -it --rm -v $(shell pwd)/src/producer/:/app -v /var/autocd:/var/autocd -p 5001:5001 autocd-producer /bin/bash -c "mvn spring-boot:run" 
 
 runClientDevImage: buildClientDevImage

README.md

@@ -48,8 +48,16 @@ wget https://github.com/fordevio/autoCD/releases/download/v$VERSION/autocd-$VERS
 unzip autocd-$VERSION.zip
 sudo nohup java -jar autocd-$VERSION.jar > output.log 2>&1 &
 ```
-The application is running in http://localhost:5001
-Output of the application is seen output.log
+Admin credintials:
+- Username: "admin"
+- Password: "admin"
+
+Change admin credentials after first login.
+
+The application is running in http://localhost:5001, Logs of autocd can be seen in output.log
 
 # Contributing to autoCD
  Visit [CONTRIBUTING.md](./docs/CONTRIBUTING.md) for contributions guidlines. 
+
+# Acknowledgements
+autoCD logo is generated using ChatGPT.

docs/DEVELOPMENT.md

@@ -31,11 +31,12 @@ git clone https://github.com/fordevio/autoCD.git
 ## Go to the wharf directory
 cd autoCD
 
-## Make docker image
-make dockerImage
+## Run docker container for java backend development
+make runProducerDevContainer
 
-## Run docker container
-make runDockerWharf
+## Run docker container for frontend react development on different terminal
+make runClientDevImage
+ 
 ```
 
 The application can be acessed by the url `http://localhost:5001`, the react application can be accessed by the url `http://localhost:3000` on browser
@@ -44,4 +45,4 @@ The application can be acessed by the url `http://localhost:5001`, the react app
 Run `make help` to get all the make commands.
 
 ## API Refs:
-Api reference can be found in [Postman collection](./autocd.postman_collection.json) .
+Api reference can be found in [Postman collection](./autocd.postman_collection.json) .

docs/TESTING.md

@@ -0,0 +1,9 @@
+# Testing
+
+- Unit and integration tests for java backend is written in [Testing](../src/producer/src/test)
+
+## Running tests
+
+```
+make tests
+```