Adds READMEs for all the services

Author: elgris

auth-api/README.md

@@ -1,6 +1,7 @@
 # auth-api
 
-This part of the exercise is responsible for authentication.
+This part of the exercise is responsible for authentication. It is written in Go and tested with Go1.9.
+
 It provides a single useful API endpoint `POST /login` that takes a simple JSON object and 
 returns an access token in case of successful authentication.
 
@@ -17,11 +18,19 @@ The JSON object structure is following:
 
 ## Configuration
 
-The binary scans environment for variables:
-- `AUTH_API_PORT` - the port the service takes .
+The service scans environment for variables:
+- `AUTH_API_PORT` - the port the service takes.
 - `USERS_API_ADDRESS` - base URL of [Users API](/users-api).
 - `JWT_SECRET` - secret value for JWT generator. Must be shared amongst all components.
 
+Following users are hardcoded for you:
+
+|| Username | Password ||
+|-----------------------|
+| admin     | admin     |
+| johnd     | foo       |
+| janed     | ddd       |
+
 ## Building and running
 
 1. Update the dependencies
@@ -34,7 +43,6 @@ go build
 AUTH_API_PORT=8000 USERS_API_ADDRESS=http://users-api:8082 JWT_SECRET=foo ./auth-api
 ```
 
-{"username": "admin","password": "admin"}
 ## Usage
 
 ```

frontend/README.md

@@ -1,8 +1,11 @@
 # frontend
 
-> UI for sample distributed TODO app
+UI for sample distributed TODO app build with VueJS
 
-## Build Setup
+## Configuration
+- `PORT` - a port the application binds to 
+
+## Building and running
 
 ``` bash
 # install dependencies

todos-api/README.md

@@ -0,0 +1,32 @@
+# todos-api
+
+This service is written in NodeJS, it provides CRUD operations over TODO entries. 
+It keeps all the data in memory. Following API endpoints are exposed:
+
+- `GET /todos?userId=id` - list all TODOs for a given user
+- `POST /todos` - create new TODO
+- `GET /todos/:taskId` - get a TODO by ID
+- `PUT /todos/:taskId` - modify a TODO by ID
+- `DELETE /todos/:taskId` - modify a TODO by ID
+
+TODO object looks like this:
+```
+{
+    id: 1,
+    userId: 1,
+    content: "Create new todo"
+}
+```
+
+## Configuration
+
+The service scans environment for variables:
+- `TODO_API_PORT` - the port the service takes.
+- `JWT_SECRET` - secret value for JWT token processing.
+
+## Building and running
+
+```
+npm install
+JWT_SECRET=foo TODO_API_PORT=8082  npm start
+```

users-api/README.md

@@ -0,0 +1,18 @@
+# users-api
+This service is written in Java with SpringBoot. It provides simple API to retrieve user data.
+
+- `GET /users` - list all users
+- `GET /users/:username` - get a user by name
+
+## Configuration
+
+The service scans environment for variables:
+- `JWT_SECRET` - secret value for JWT token processing.
+- `SERVER_PORT` - the port the service takes.
+
+## Building and running
+
+```
+./mvnw clean install
+JWT_SECRET=foo SERVER_PORT=8083 java -jar target/users-api-0.0.1-SNAPSHOT.jar
+```