github.com/vegggg/user-management

User Manual

To Run this project on localhost try: $ docker-compose up

Directory explain

• cmd/ I use cobra as to implement a commandline application. Basicly, this project is started from cmd/server.go Stuff like init db connection, DI... are also there

• main.go Only to init cmd/

• init.sql Sql schema init script

• Dockerfile, docker-compose For ease deployment

• prototool.yaml A prototool plugins manager/linter

• vendor/ I use go vendor to manage project's dependencies

• proto/ Protobuf files to define service API, models, entities

• handler/ A handler that implement service API interface, All it does is controlling the business flow

• otp/ otp service: use a Redis instance to maintain user's OTP and user status of "is validated by OTP"

• user/ user service this package is defined a bit general Currently, I have implemented a sqlrepo for managing users. It also has a redis repo for future caching feature. In addition, in sqlrepo, we can easily add a psql for more flexibility.

• entity/ Contains entities

• docs/ A postman collection json to run demo

API flow

API can be found in docs/

• Create User

  • POST localhost:8080/v1/users:sendOTP body: phone Response must includes a OTP since I can NOT send a SMS
  • POST localhost:8080/v1/users:verifyOTP body: phone + otp (otp is only valid in 1 min)
  • POST localhost:8080/v1/users body: {UserStruct} with validated otp (also expire after 1 min since otp validation)

• Get User

  • GET localhost:8080/v1/users/{phone}

Run test

$ docker-compose up $ go test ./...