Skip to main content

Join Us

Just a few steps to start contributing to VanSail.

  1. 1

    Install Z Shell (optional)

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    brew install zsh
  2. 2

    Install Git

    brew install git
  3. 3

    Install Node.js

    Go to the Node.js download page, pick your OS and version, then run the installer.
    We recommend Yarn for package management.

  4. 4

    Fork the repository

    Click Fork on GitHub to copy this project under your personal account.

  5. 5

    Clone the source

    Clone your fork to your machine:

    git clone https://github.com/<your-name>/VanSail.github.io.git
  6. 6

    Install dependencies

    Enter the project directory and install dependencies:

    cd VanSail.github.io
    yarn install
  7. 7

    Start dev server

    Launch the local dev server with live reload to preview changes as you edit:

    yarn start
  8. 8

    Build the site

    Compile the source into a static site, output to the build directory:

    yarn build
  9. 9

    Serve the build

    Serve the compiled static site locally to verify the final result before publishing:

    yarn serve
  10. 10

    Edit & open a PR

    After editing, commit your changes and open a Pull Request to the main repo for review.