Compare commits

...

7 Commits

Author SHA1 Message Date
shatoboar
57472fb84f fix(README.md) Codacy style 2022-06-28 13:58:51 +02:00
shatoboar
2ddf24c7eb move contribution docs to the official docs repo 2022-06-28 13:46:11 +02:00
shatoboar
841fa44072 feat(README.md) add section about contributing to the project 2022-06-28 13:38:59 +02:00
shatoboar
2c2790603e feat(contribution.md) project setup 2022-06-22 17:21:36 +02:00
shatoboar
f31f8a76fb Move contribution.md to docs folder 2022-06-22 15:50:43 +02:00
shatoboar
b052e74fe7 Code guide for new contributors
Description for daemon, CLI and UI
2022-06-22 15:50:15 +02:00
shatoboar
89f9c498f1 Update (architecture.md) 2022-06-22 15:45:51 +02:00
2 changed files with 35 additions and 1 deletions

View File

@@ -105,3 +105,33 @@ We use open-source technologies like [WireGuard®](https://www.wireguard.com/),
### Legal
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
### Contribution
**You have a working Go environment**
Clone the project into your preferred path. We recommend just cloning into the GOPATH.
```bash
mkdir -p $GOPATH/src/github.com/netbirdio
cd $GOPATH/src/github.com/netbirdio
git clone git@github.com:netbirdio/netbird.git
cd netbird
go build ./...
```
**Sidenote**
*`libayatana-appindicator3-dev` might be needed for developing
the client-ui [ui](https://github.com/netbirdio/netbird/tree/main/client/ui) on debian based distros.*<br>
**Sidenote**
*The command won't produce a binary, but only check for working builds.
If you want to produce a binary, you need to `cd` into the specific subproject and use `go build`.*
**To run the tests run**
```bash
go test -exec sudo ./...
```
The tests need to be executed with sudo permissions, as our integration tests need to create network interfaces.
For further information about contributing to the Netbird project, please refer to our [documentation](https://netbird.io/docs/development/contributing).

View File

@@ -1,2 +1,6 @@
### Architecture
TODO
**Our docs have moved to a separate [repository](https://netbird.io/docs).** <br>
To get more insight into netbird's architecture refer to this [documentation](https://netbird.io/docs/overview/architecture).