empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add workspace preparation instructions (#1833)

Browse Source 
Individuals unaccustomed to building Go projects from source may encounter difficulties cloning into the repo if they choose an arbitrary directory not in ~/go/src. Attempting to build the repo elsewhere will result in the `make deps` command failing. This change adds workspace prep instructions.
This commit is contained in:
Fritz 2018-06-18 11:23:52 -04:00 committed by Mike Arpaia
parent 8f0131cc1d
commit ece499d2f6
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/development/building-the-code.md
View File

@ -1,7 +1,11 @@
Building The Code
=================
## Installing build dependencies
## Building the Code
Checkout this repository to `$GOPATH/src/github.com/kolide/fleet`. If you're new to Go and you don't know about `$GOPATH`, then check out the repo to `$HOME/go/src/github.com/kolide/fleet`. You will also need to install Go (1.9 or greater).
* [Go Documentation: Workspaces](https://golang.org/doc/code.html#Workspaces)
To setup a working local development environment, you must install the following minimum toolset:
@ -10,10 +14,9 @@ To setup a working local development environment, you must install the following
* [GNU Make](https://www.gnu.org/software/make/)
* [Docker](https://www.docker.com/products/overview#/install_the_platform)
If you're using MacOS or Linux, Make should be installed by default. If you are using Windows, you will need to install it separately.
Once you have those minimum requirements, you will need to install Fleet's dependent libraries. To do this, run the following:
Once you have those minimum requirements, you will need to install Fleet's dependent libraries. To do this, run the following from the root of the repository:
```
make deps
@ -21,11 +24,6 @@ make deps
When pulling in new revisions to your working source tree, it may be necessary to re-run `make deps` if a new Go or JavaScript dependency was added.
```
make generate
```
## Generating the packaged JavaScript
To generate all necessary code (bundling JavaScript into Go, etc), run the following: