Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.51 KB

directory.md

File metadata and controls

20 lines (16 loc) · 1.51 KB
Raw

Directory Structure

There are couple of directories in this repository and to understand those, lets go one by one.

  • api: contains the schema definitions for the applications. Currently we are using only proto schema for pub/sub integration with message application, hence the message.proto files is defined in the ../api/message directory.
  • build: mosty contains the docker related configuration and volumes to bind so that container does lose any configuration such as grafana or prometheus.
  • cmd: contains the applications that we are creating to explore the microservices and related area.
  • docs: contains the documentations such as this document to explain different parts of the repository.
  • pkg: contains the different wrapper kind of packages on top of exploratory libraries that we are using in our applications. For example, db package returns an instance of sql.DB to use by connecting to a mysql or postgresql database depends on given configuraiton.
  • tasks contains the task files that can be imported to main Taskfile.yml. Those files defines certain tasks to ease out the process of local development.
  • standalone files:
    • .gitignore
    • docker-compose.yml
    • Dockerfile.sample: the dockerfile used to build the sample application.
    • README.md: to contain the main documentation for the repository.
    • Taskfile.yml: the main file to run the task commands.