Skip to content

Latest commit

 

History

History
58 lines (46 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

58 lines (46 loc) · 2.69 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Table of Contents

Repostiory Layout

  • api : proto buffer specs, swagger manifests.
  • build : docker files, makefiles, packer scripts.
  • cmd: main applications for this project.
  • configs: Configuration file templates or default configs.
  • deployments: aws configs.
  • docs: design and user documents (in addition to your godoc generated documentation).
  • pkg : core package implementations and consumer instance.
  • scripts: scripts to perform any build, install, analysis, etc operations.
  • services: represen the different services.
  • testdata: test dat/fixtures, (the tests are found on the location as the go code).

Makefiles

  • The .env contains the environment variables for project configuration.
  • Nearly all operations that we work with daily in this project, is automated using makefiles. You can print thefull list of supported commands by typing make on the root directory:
 make
help                           This help.
awscli-install                 Install aws cli tool and configure it
docker-build                   Build the container
docker-build-nc                Build the container without caching
docker-run                     Run container on port configured in `config.env`
...
protobuf-generate-api          Generates protocol buffers definitions files.
protobuf-generate-api-all      Generates protocol buffers definitions files for all AVs.
protobuf-install-compiler      Install protobuf compiler
protobuf-protoc-gen-go         Install protoc plugin for Go
certbot-install                Install Certbot for nginx
elastic-drop-db                Delete all indexes.
  • Your commits should follow the conventional commits specification.
  • After staring docker-compose, the samples volume is mounter as root and to make it readable/writable for the different containers:
    • list the docker volumes using: docker volume ls and look for the samples volume name.
    • inspect the volume by running: docker volume inspect <volume_name>, this command will show you where the volume is store on the local disk.
    • finally change the volume permissions: chmod -R 777 <sample_dir>.

Port Mapping

  • 4150: nsqd TCP port
  • 4151: nsqd HTTP port
  • 4160: nsqlookupd TCP port
  • 4161: nsqlookupd HTTP port
  • 4171: nsqadmin HTTP