Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Windows dev guide #214

Merged
merged 7 commits into from
Sep 21, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions contrib/setup_windows_build_environment.md
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