beginning of readme

README.md

@@ -0,0 +1,35 @@
+# Transaction Auth Service Assignment
+
+## Building / Running
+
+To run the application in a docker compose setup:
+
+```
+./gradlew build -x test
+docker compose up --build
+```
+
+This will start Kafka (and Zookeeper), the "authentication service," and the websocket API. The test UI is available on http://localhost:8080/
+
+## Using
+
+To use the test UI, press the Connect button to activate the websocket. Then a station UUID and driver identifier can be filled in and sent to the service via the websocket connection.
+ - Any station UUID can be given, as long as it's a UUID.
+ - There are two identifiers in the hardcoded whitelist by default. They are listed on the page itself.
+
+## Running Tests
+
+```
+./gradlew test
+```
+
+This will run all the tests, both unit tests and integration tests.
+
+## Notes
+
+Notes and thoughts on development of the application:
+ - I think it would make sense to return more information in the response, given the fully async communication. Like driver and station IDs.
+ - It would be useful to return more detailed error messages in responses instead of just "Invalid."
+
+Design:
+ - I used Arrow for typed error handling in the validation.