# lightproxy

**Repository Path**: freemo/lightproxy

## Basic Information

- **Project Name**: lightproxy
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-14
- **Last Updated**: 2021-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![Build](https://github.com/alibaba/lightproxy/workflows/Build/badge.svg)
![Build doc and Deploy](https://github.com/alibaba/lightproxy/workflows/Build%20and%20Deploy/badge.svg)
![Stable version](https://img.shields.io/badge/dynamic/json?url=https://gw.alipayobjects.com/os/LightProxy/release.json&label=Stable%20Version&query=$.version)
![Beta version](https://img.shields.io/badge/dynamic/json?url=https://gw.alipayobjects.com/os/LightProxy/beta-release.json&label=Beta%20Version&query=$.version)
![GitHub issues](https://img.shields.io/github/issues/alibaba/lightproxy)
![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/alibaba/lightproxy)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

<p align="center">
  <img src="./vendor/files/icon.png" height="150px"/></a>
</p>

<p align="center">
<b><a href="https://lightproxy.org/doc/getting-started#download">Download</a></b>
|
<b><a href="https://lightproxy.org/doc/getting-started">Document</a></b>
|
<b><a href="CONTRIBUTING.org">Contribute</a></b>
|
  <b><a href="https://github.com/alibaba/lightproxy/issues/117">Introduction</a></b>
|
<b><a href="https://github.com/alibaba/lightproxy/issues/19">介绍文章</a></b>
|
<b><a href="https://alibaba.github.io/lightproxy/start-proxy-only.html">FAQ</a></b>

</p>
<p align="center">
<a href="https://www.producthunt.com/posts/lightproxy?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-lightproxy" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=195432&theme=light" alt="LightProxy - Open-source proxy tools for macOS & Windows based on whistle | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a>
</p>

--- 
:package: Out-of-box, fully automation with **certificate install & system proxy setting**

:battery: Battery include, powerful `hosts/proxy/capture` based on `whistle`, what u need is just input `/`

:electric_plug: Hackable, you colud write even Node.js for your proxy rule

--- 


## Get Start
<p align="center">
  <a href="https://lightproxy.org">
    <img src="https://i.loli.net/2020/05/10/E3peTy9PFbzU5aA.png"></img>
  </a>
  <p align="center">
    <a href="https://lightproxy.org">Get Start</a>
  </p>
</p>

## Preview
<p align="center">
  <img src="https://img.alicdn.com/tfs/TB1mCIVEYr1gK0jSZR0XXbP8XXa-1232-812.png"></img>
</p>

## Preview GIF
<p align="center">
  <img src="https://i.loli.net/2020/05/05/uRZMpi8rPDyQF6I.gif"></img>
</p>

## Download

[macOS Version Download](https://gw.alipayobjects.com/os/LightProxy/LightProxy.dmg)

[Windows Version Download](https://gw.alipayobjects.com/os/LightProxy/LightProxy-Setup.exe)

## Quick Start

Take a quick start at: https://lightproxy.org/doc/getting-started

## How to contribute

### env

- nodejs > 12 (**important**)
- `npm install -g electron-builder` if you need bundle application

### dev

```shell
git clone https://github.com/alibaba/lightproxy
cd lightproxy
yarn run install-deps
yarn run dev
```

For new contributors you can try to fix a [🏅send-a-PR](https://github.com/alibaba/lightproxy/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%8F%85send+a+PR%22)



## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://www.xcodebuild.com/"><img src="https://avatars3.githubusercontent.com/u/5436704?v=4" width="100px;" alt=""/><br /><sub><b>xcodebuild</b></sub></a><br /><a href="https://github.com/alibaba/lightproxy/commits?author=xcodebuild" title="Code">💻</a> <a href="#ideas-xcodebuild" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/alibaba/lightproxy/pulls?q=is%3Apr+reviewed-by%3Axcodebuild" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-xcodebuild" title="Maintenance">🚧</a></td>
    <td align="center"><a href="https://github.com/Runly"><img src="https://avatars3.githubusercontent.com/u/18432577?v=4" width="100px;" alt=""/><br /><sub><b>Ranly</b></sub></a><br /><a href="https://github.com/alibaba/lightproxy/commits?author=Runly" title="Code">💻</a> <a href="#question-Runly" title="Answering Questions">💬</a> <a href="https://github.com/alibaba/lightproxy/pulls?q=is%3Apr+reviewed-by%3ARunly" title="Reviewed Pull Requests">👀</a></td>
    <td align="center"><a href="https://www.ahonn.me"><img src="https://avatars3.githubusercontent.com/u/9718515?v=4" width="100px;" alt=""/><br /><sub><b>Yuexun Jiang</b></sub></a><br /><a href="#design-ahonn" title="Design">🎨</a> <a href="https://github.com/alibaba/lightproxy/commits?author=ahonn" title="Code">💻</a> <a href="https://github.com/alibaba/lightproxy/pulls?q=is%3Apr+reviewed-by%3Aahonn" title="Reviewed Pull Requests">👀</a></td>
    <td align="center"><a href="https://github.com/avwo"><img src="https://avatars2.githubusercontent.com/u/11450939?v=4" width="100px;" alt=""/><br /><sub><b>avenwu</b></sub></a><br /><a href="https://github.com/alibaba/lightproxy/commits?author=avwo" title="Code">💻</a></td>
    <td align="center"><a href="https://usememo.dev"><img src="https://avatars0.githubusercontent.com/u/10394160?v=4" width="100px;" alt=""/><br /><sub><b>Mashiro Wang</b></sub></a><br /><a href="https://github.com/alibaba/lightproxy/commits?author=MashiroWang" title="Code">💻</a></td>
    <td align="center"><a href="https://williamchan.me"><img src="https://avatars1.githubusercontent.com/u/9210430?v=4" width="100px;" alt=""/><br /><sub><b>William Chan</b></sub></a><br /><a href="https://github.com/alibaba/lightproxy/commits?author=luckyyyyy" title="Code">💻</a></td>
    <td align="center"><a href="https://blog.njzydark.com/"><img src="https://avatars3.githubusercontent.com/u/19601720?v=4" width="100px;" alt=""/><br /><sub><b>njzy</b></sub></a><br /><a href="https://github.com/alibaba/lightproxy/commits?author=njzydark" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->