search

minibolt-guide / minibolt

A step-by-step guide to building a Bitcoin & Lightning node, and other stuff on a personal computer
https://minibolt.info
MIT License
74 stars 37 forks source link

[DEV Improvement] set up a local dev environment #31

Closed 1ma closed 1 year ago

1ma commented 1 year ago

This is only a convenience for MiniBolt contributors. To use it on Ubuntu/Debian:

First time setup

  1. Install Ruby:

    $ sudo apt install ruby3.0 ruby3.0-dev

  2. Set $GEM_HOME and $GEM_PATH to $HOME/.gem, and add $GEM_HOME/bin to your $PATH.

    
$ nano ~/.profile

add

export GEM_HOME="$HOME/.gem" export GEM_PATH="$GEM_HOME"

modify

export PATH="$PATH:$GEM_HOME/bin"

Reboot, or just reload the profile file for the changes to take effect immediately in the current terminal session:

$ source ~/.profile


2. Install [Bundler](https://bundler.io/), Ruby's package manager:

$ gem install bundler $ which bundle /home/1ma/.gem/bin/bundle


3. Navigate to the MiniBolt project directory and install MiniBolt's dependencies with Bundler:

$ bundle install


## Development Flow

Open a terminal, and from inside the project directory run:

$ bundle exec jekyll serve --livereload --incremental


Open the browser at [http://localhost:4000](http://localhost:4000). Each change you make in the .md files is reflected automatically after a few seconds.
twofaktor commented 1 year ago

LGTM untested ACK! let's go to the main!