Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 807 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 807 Bytes

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.

Repostiory Layout

  • pkg : library code to use by external applications.
  • website : saferwall website and documentation.
  • ui : (frontend) vue.js dashboard.
  • web : (backend) go web application.
  • build : docker files, makefiles, kubernetes deployements.
  • api : proto buffer specs.

Requirements

- sudo apt-get install make curl
- touch .env

Once you do that, you can do nearly everything using make, you can look at the supported options by executing a make.