Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 3.07 KB

README.md

File metadata and controls

118 lines (82 loc) · 3.07 KB
Raw

takeme-app Backend Service

takemeApp is a simple backend service for dating app. The name takemeApp is a pun for telling "take me up".

Features

  • Register & Login
  • Find Users
  • Create Reaction (swipe left or right) with caching
  • Premium features to unlock limitations

Clone

First clone this repo by run:

$ git clone [email protected]:notblessy/takeme-backend.git

Run takeme-app in local

Initialize

Firstly, run:

$ go mod tidy

Environment

  • The sample environments are provided in root folder
    • If you run takeme-app in local, use config.yml.sample to be config.yml file.

Database Migration

  • Ensure you have already installed Makefile and created the database. To migrate tables, run:
$ make migration
  • To seed necessary data:
$ make seeder

Running app

  • To run HTTP server with hot reloading by listens changes, hit:
$ make run

Or just go run main.go httpsrv if you don't need hot reload.

Unit Test & Lint

  • Test command includes linters which you need to install golangci-lint.
<!-- macOS -->
brew install golangci-lint

Then run make test.

API Documentations

  • To test the API, import postman collection from folder api-docs/. All the API is available there.
  • Create environtment in postman, there are 2 necessary variables for testing.
    • host. represents basehost value
    • token. represents auth token

Architecture

  • takeme-app uses a clean architecture referenced by go-clean-arch https://github.com/bxcodec/go-clean-arch. It has 4 domain layers such

    • Models Layer provides domain models
    • Repository Layer communicates to persistence layer
    • Usecase Layer stores action of process
    • Delivery Layer exchanges data between client & system

  • Here's some reason why referencing go-clean-arch:

    • Scalable:
      • As the application grows, it'll be easier adding new features or modify existing ones without widespreading negative impacts.
    • Reliable:
      • Domains are easly and independently testable.
      • Adapting Domain driven design & SOLID principles.
    • Maintainable
      • A way more organized code. Even with separated layers, still encapsulates logic business that may not affect other logic when having updates/changes.
      • Code should not depend on one developer. Readable codes will saves time and effort of developers in future.

  • takeme-app especially this service, could run process separately using cobra as commands in one main function. For the example, httpsrv is the command for running http service, likewise migration to run migration. This also good approach if we intend to use worker or exposing another port in the future.

Stacks

  • golang as the programming language
  • echo as the HTTP Framework
  • cobra runs command
  • mysql as the RDBMS
  • gorm as the ORM
  • redis for caching
  • dbmate as db migration
  • mockgen for mocking
  • gocognit to check cognitive complexity
  • golangci-lint as linters
  • .modd to perform hot reload on changes
  • makefile utility for executing task

Author

I Komang Frederich Blessy