-
-
Notifications
You must be signed in to change notification settings - Fork 417
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #214 from CodyGramlich/windows-dev-guide
Windows dev guide
- Loading branch information
Showing
1 changed file
with
72 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# How to set up the build environment for Browsh on Windows | ||
This guide is for those who want to set up the build environment on Windows Command Prompt or Powershell. Since some of the shell scripts are needed to set up the environment, you can just use **Git Bash** to run these scripts. | ||
|
||
|
||
## Setting up Go, NodeJs, and GOPATH | ||
Download and install Go for Windows at [Go download page](https://golang.org/dl/). | ||
|
||
Download and install NodeJs for Windows at [NodeJs download page](https://nodejs.org/en/download/) | ||
|
||
Using Command Prompt or Powershell: | ||
|
||
Create a go workspace: | ||
> mkdir go | ||
> cd go | ||
Set GOPATH to current directory. | ||
> set GOPATH=%cd% | ||
Create subdirectories bin and src within your go directory: | ||
> mkdir bin | ||
> mkdir src | ||
Add %GOPATH%/bin to your PATH. | ||
|
||
## Installing chocolatey and dep | ||
|
||
Download and install Chocolatey package manager at [Chocolatey download page](https://chocolatey.org/install). | ||
|
||
Using chocolatey package manager run: | ||
> choco install dep | ||
|
||
## Installing webpack, web-ext, and Firefox | ||
> npm install -g --no-audit webpack | ||
> npm install -g --ignore-scripts web-ext | ||
Download and install Firefox for Windows at [Firefox download page](https://www.mozilla.org/en-US/firefox/new/). | ||
Note: **Version 57 or higher is required.** | ||
|
||
|
||
## Cloning the browsh repository | ||
Navigate to GOPATH/src and run: | ||
> git clone https://github.com/browsh-org/browsh.git | ||
|
||
## Setting up dependencies | ||
Navigate to browsh/webext and run: | ||
> npm install | ||
## Building browsh with Git Bash | ||
Using Git Bash, navigate to browsh/interfacer/contrib and run: | ||
> ./build_browsh.sh | ||
## Running browsh | ||
Using three Command Prompts or Powershells: | ||
|
||
Navigate to GOPATH/browsh and run: | ||
> go run ./interfacer/src/main.go --firefox.use-existing --debug | ||
Navigate to browsh/webext and run: | ||
> webpack --watch | ||
Navigate to browsh/webext/dist and run: | ||
> web-ext run --verbose | ||
|
||
|
||
|
||
|