Skip to content
This repository was archived by the owner on Apr 28, 2018. It is now read-only.

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

Development

Architecture

blinksocks-desktop is based on Node.js and electron.

blinksocks-desktop

Requirements

We assume that your system has basic unix tools and shell environment. Apart from that, you should have had the following tools installed:

  • Node.js 6 or later
  • OpenSSL
  • gzip
  • Golang

Quick Start

First download source code via git:

# Clone the repository
$ git clone https://github.com/blinksocks/blinksocks-desktop

# Go into the repository
$ cd blinksocks-desktop

There are several npm scripts(see package.json) used for different purposes:

# Install the dependencies and run
$ yarn install

# Start front-end development server
$ yarn start-dev

# Open a new terminal then start electron
$ yarn start-app

# Start electron with devtools
$ yarn start-app -- --devtools

Build for multiple platforms

# Compile front-end sources
$ yarn build

# Pack, generate patch, gzip then calculate sha256, compile sudo-agent for macOS
$ yarn release

Trouble Shooting

  1. Install is too slow and always fail.

Try to change npm registry and electron mirror to another one:

// ~/.npmrc
registry=https://registry.npm.taobao.org/
electron_mirror="https://npm.taobao.org/mirrors/electron/"