diff --git a/app-service-template/README.md b/app-service-template/README.md index 7a22e81dc..a4de0c017 100644 --- a/app-service-template/README.md +++ b/app-service-template/README.md @@ -8,34 +8,36 @@ Follow the instructions below to create your new customer application service: 1. Copy contents of this folder to your new folder -2. Change name `new-app-service` in go.mod to an appropriate Go Module name for your service +2. Change name `new-app-service` in go.mod file to an appropriate Go Module name for your service - Typically this is the URL to the repository for your service -3. Do a global search and replace on `new-app-service` to replace it with the name of your service +3. Remove the `replace` statement from the go.mod file + +4. Do a global search and replace on `new-app-service` to replace it with the name of your service - Note that this name is used as the service key, so it needs to use dashes rather than spaces in the name and avoid other special characters -4. Adjust your local import statements to match the name you selected in the go.mod file +5. Adjust your local import statements to match the name you selected in the go.mod file - Only needed in `main.go` if the Go Module name changed to a URL -5. Run unit tests to verify changes didn't break the code +6. Run unit tests to verify changes didn't break the code - `make test` -6. Verify you are able to build the executable +7. Verify you are able to build the executable - `make build` -7. Update the `Makefile` docker build to adjust image name appropriately +8. Update the `Makefile` docker build to adjust image name appropriately -8. Verify the docker image still builds with your new image name +9. Verify the docker image still builds with your new image name - `make docker` -9. Address all the TODO's in the source files and add your custom code +10. Address all the TODO's in the source files and add your custom code -10. Build and test your new custom application service +11. Build and test your new custom application service \ No newline at end of file