Skip to main content

Setup

This guide will walk you through setting up your development environment for Bunkr. Since everyones setup is different, we'll try to keep this guide as general as possible. If you run into any issues, please open an issue and we'll do our best to improve this guide.

Prerequisites

Git
GoSee go.mod for required version.
npmNode 15 or higher
WailsCheckout the official docs for installation instructions.
You can find the required version of Wails in go.mod.
SqlCGenerates our database boilerplate code from SQL schema and query definitions.
templUsed to generate our frontend templates.
optional but recommended
VS CodeA code editor.
VS Code ExtensionsSee [extensions.json](https://github.com/bunkr-dev/app/blob/main/.vscode/extensions.json).
GolangCI-LintA collection of Go linters we use to improve code quality and ensure consistency.

Getting Started

  1. Clone the repository.
    git clone git@github.com:bunkr-dev/app.git 
  2. Install Go dependencies.
    cd src
    go mod download
  3. Generate code. (Database, Views, etc.)
    go generate  
  4. Install npm dependencies.
    cd src/frontend
    npm install
  5. Run the app from the src directory.
    wails dev

🎉 You should now have a working Bunkr app running on your machine!

Building

From the src directory, run:

wails build

You can find the built binaries in src/build/bin.