From c064f95e9be6b208c265842d9b7361c59c88104c Mon Sep 17 00:00:00 2001 From: madhurvelotio Date: Tue, 27 Oct 2020 19:37:54 +0530 Subject: [PATCH] Added guidelines for submission --- README.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f4ba7b0..5502dc6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ # go-k8s-training +--- +### Exercise 1 +Topics covered: +API development and Http communication using client, Json Encoding/decoding, DB connection, Docker , Helm, k8s +Create a private git repo for this and add a Readme.md explaining the steps to run you application using Docker and k8s + +- Create a small e-commerce backend having two micro-services: `User` and `Order`. For now ignore the authentication part. `User` service only will be exposed to the public and will communicate with the `Order` service for any order related queries. -## Exercise 1 -Create a small e-commerce backend having two micro-services: `User` and `Order`. For now ignore the authentication part. `User` service only will be exposed to the public and will communicate with the `Order` service for any order related queries. -You are admin and can perform all operations. Things to consider +- You are admin and can perform all operations. Things to consider 1. Handle CRUD operation of Users and Orders. There can be 1:n mapping between user and orders. 2. Can only update one order at a time 3. Can delete one or all orders of a user at a time @@ -12,6 +17,24 @@ You are admin and can perform all operations. Things to consider Eg: http://localhost:80/users -> all users http://localhost:80/users/0/orders -> all orders of user 0 http://localhost:80/users/0/orders/0 - order 0 of user 0 -Topics covered: -API development and Http communication using client, Json Encoding/decoding, DB connection, Docker , Helm, k8s -Create a private git repo for this and add a Readme.md explaining the steps to run you application using Docker and k8s +--- + +### General Requirement + +- Comment all the things you are doing + +- Code should be structured even though it is an assignment + +- write up a simple summary of what you tried to do and how did you do in the commit comments + +- Follow some good go repo template like https://github.com/IBM/go-repo-template +--- + +### Submission + +- Fork this repository and work on it + +- Raise a PR against this repository + +- Add/ Tag the reviewer for that PR +---