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.
- 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.
- docs: design and user documents (in addition to your godoc generated documentation).
- deployments: helm chart.
- pkg : library code to use by external applications.
- scripts: scripts to perform any build, install, analysis, etc operations.
- test: test data, (the tests are found on the location as the go code).
- ui : (frontend) vue.js dashboard. (saferwall.com)
- web : (backend) go web application. (api.saferwall.com)
- website : saferwall website and documentation (about.saferwall.com)
- Copy the
example.envto.env. This file stores the 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
makeon 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.- WIP
- WIP