Skip to content

Latest commit

 

History

History
130 lines (80 loc) · 3.8 KB

GETTING_STARTED.md

File metadata and controls

130 lines (80 loc) · 3.8 KB
Raw

Getting Started

Dependencies

Before you can start working on Burrow, you'll need to install some dependencies. They are different for each platform:

Linux
  1. Install rustup using the instructions on the website:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Install Visual Studio Code from the website, Snap Store, or your package manager of choice.
macOS
  1. Install rustup using the instructions on the website:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Download and install Visual Studio Code from the website, or by using brew:
brew install --cask visual-studio-code

  1. Download and Install Xcode from the App Store or the Apple Developer website.

  2. Make sure the "current" version of Xcode matches the one you are using:

$ xcode-select -p

If the output is not the version of Xcode you just installed, run the following command to switch to the new version:

$ sudo xcode-select -s {PATH_TO_XCODE}
Windows

  1. Download Visual Studio community edition from the website. Install the components for "Desktop Development with C++"

  2. Install Visual Studio Code, PowerShell and Windows Terminal from the Microsoft Store

  3. Open Windows Terminal and use winget to install git, LLVM and rustup:

winget install Git.Git
winget install LLVM.LLVM
winget install Rustlang.Rustup
  1. Install Rust using rustup:
rustup toolchain install stable-msvc

Building

  1. Clone the repository:
git clone git@github.com:hackclub/burrow.git
  1. Open the burrow folder in Visual Studio Code:
code burrow
  1. Install the Visual Studio Code extensions rust-analyzer and CodeLLDB. You should get a suggestion to do this automatically:

  1. Compile burrow in Visual Studio Code by selecting Terminal -> Run Build Task

Running

Command Line

You can run burrow on the command line with cargo:

cargo run

Cargo will ask for your password because burrow needs permission in order to create a tunnel.

Visual Studio Code

You can debug the Rust program inside of Visual Studio using the Run and Debug tab.

This does not work fully yet. Visual Studio Code does not have a way to debug programs with administrative privileges.

iOS or macOS

You can run the Burrow app on iOS or macOS using Xcode.

You will need to be logged in with your Apple ID, and it should be a part of The Hack Foundation team:

If your Apple ID is not a part of The Hack Foundation team, ask the Slack channel for assistance.

You should now be able to run the app by opening Apple/Burrow.xcodeproj in Xcode, selecting the App scheme and clicking Run.