Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeanshuang/potatso

适配Xcode9.3 iOS11.3 Swift3.3编译通过。 (unmaintained) Potatso is an iOS client that implements Shadowsocks proxy with the leverage of NetworkExtension framework in iOS 9.
https://github.com/jeanshuang/potatso

potatso shadowsocks ss ssr vpn

Last synced: 3 months ago
JSON representation

适配Xcode9.3 iOS11.3 Swift3.3编译通过。 (unmaintained) Potatso is an iOS client that implements Shadowsocks proxy with the leverage of NetworkExtension framework in iOS 9.

Awesome Lists containing this project

README 

        
# How to Build Project

#  怎么编译

1. `git clone --recursive https://github.com/JeansHuang/Potatso.git

` 

2. `carthage update --platform ios` 

3. build support Xcode9.3 iOS11.3 Swift3.3



---



donate



# Potatso ![GPLv3 License](https://img.shields.io/badge/License-GPLv3-blue.svg)



## Important



Please read [this](https://github.com/haxpor/Potatso/blob/master/ADHERE_LICENSE.md) first before you do anything with this project.  

In short, you need to respect to license of the project. You cannot copy the source code and publish to App Store.



---



## What is it?



Potatso is an iOS client that implements custom proxies with the leverage of Network Extension framework introduced by Apple since iOS 9.



Currently, Potatso is compatible with following proxies:



- [Shadowsocks](https://shadowsocks.org)

- [ShadowsocksR](https://github.com/breakwa11/shadowsocks-rss)



[Subscribe Telegram Channel](https://telegram.me/potatso) to get updates of Potatso.  

[Join Telegram Group](https://telegram.me/joinchat/BT0c4z49OGNZXwl9VsO0uQ) to chat with users.



Original Author: [@icodesign](https://twitter.com/icodesign_me)  

Swift 3 Maintainer: [@haxpor](https://twitter.com/haxpor)



## Project Info



Potatso has in total 33 (2 as submodules dependencies as used as local file in Cocoapod) dependencies as following



* 28 Cocoapod dependencies

* 1 Carthage dependency

* 4 submodules dependencies



The project is tested with Xcode `8.2 (8C38)` on iOS `10.2 (14C92)` device with cocoapod version `1.1.1`+, and carthage version `0.18.1`.  

If you experienced an expected issue, try to use those versions.



## Change log



You can take a look at [Change log](https://github.com/haxpor/Potatso/wiki/Change-log) for changes that has made for specific commit that has significant updates. Thus you can freely decide whether you want to rebuild Potatso to include such update or not.



## How to Build Project



Perform the following steps to be able to build the project.

Be warned that you **should not** call `pod update` as newer version of pod frameworks that Potatso depends on might break building process and there will be errors.



1. `git submodule update --init` to update git submodule

2. `pod install` to pull down dependencies into our project

3. `carthage update` to pull down dependencies into `Carthage/Checkouts` folder and build each one

4. Open `Potatso.xcworkspace` then Build and Run the project. Done.



## Build Notices



If you try to build for iOS 10.3, please try to use XCode Version 8.3 (8E162) onwards and only for release version.



## Code Notices



There're a couple of issues that needed to look at, but after testing, it does **not** affect the functionality of the app.



* In file `Potatso/Core/API.swift`, it's the following code focusing on line with comment that I can't figure it out yet how to migrate it to Swift 3 code.  



   ```swift

   var JSONToMap: AnyObject?

   if let keyPath = keyPath, keyPath.isEmpty == false {

       //JSONToMap = (result.value? as AnyObject).value(forKeyPath: keyPath)

       JSONToMap = nil

   } else {

       JSONToMap = result.value as AnyObject?

   }

   ```

* Potatso core code depends on version `1.7.0` of Eureka with manual migration to Swift 3. It's already done and linked to project. But you will see `observeValue()` function in `Eureka/Source/Rows/PostalAddressRow.swift` that has been commented for all of its function code due to Eureka's newer version `2.0.0-beta.1` doesn't include such file in the project anymore, but it still works with no problem. This note is meant to mark that there is going to be a lot of effort if we decide to depend on Eureka version `2.0.0-beta.1` as we need to change a lot of Potatso core code.

   

## How To Contribute



Clone the project, make some changes or add a new feature, then make a pull request.



## Acknowlegements



We use the following services or open-source libraries. So we'd like show them highest respect and thank for bringing those great projects:



### Services



- [Fabric](https://get.fabric.io/)

- [Reveal](http://revealapp.com/)

- [realm](https://realm.io/)

- [HelpShift](https://www.helpshift.com)



### Open-source Libraries



- [KissXML](https://github.com/robbiehanson/KissXML)

- [MMWormhole](https://github.com/mutualmobile/MMWormhole)

- [CocoaAsyncSocket](https://github.com/robbiehanson/CocoaAsyncSocket)

- [Cartography](https://github.com/robb/Cartography)

- [AsyncSwift](https://github.com/duemunk/Async)

- [Appirater](https://github.com/arashpayan/appirater)

- [Eureka](https://github.com/xmartlabs/Eureka)

- [MBProgressHUD](https://github.com/matej/MBProgressHUD)

- [CallbackURLKit](https://github.com/phimage/CallbackURLKit)

- [ISO8601DateFormatter](https://github.com/boredzo/iso-8601-date-formatter)

- [Alamofire](https://github.com/Alamofire/Alamofire)

- [ObjectMapper](https://github.com/Hearst-DD/ObjectMapper)

- [CocoaLumberjack](https://github.com/CocoaLumberjack/CocoaLumberjack)

- [AlamofireObjectMapper](https://github.com/tristanhimmelman/AlamofireObjectMapper)

- [YAML.framework](https://github.com/mirek/YAML.framework)

- [tun2socks-iOS](https://github.com/shadowsocks/tun2socks-iOS)

- [shadowsocks-libev](https://github.com/shadowsocks/shadowsocks-libev)

- [Antinat](http://antinat.sourceforge.net/)

- [Privoxy](https://www.privoxy.org/)



### Also we'd like to thank people that helped with the project



- [@Blankwonder](https://twitter.com/Blankwonder)

- [@龙七](#)

- [@haxpor](https://twitter.com/haxpor)

- TestFlight Users and [Telegram Group](https://telegram.me/joinchat/BT0c4z49OGNZXwl9VsO0uQ) users.



### Donate

- [@liqianyu](https://twitter.com/liqianyu)

- [@anonymous](#) x2



## Notice



Potatso 2 was released on [App Store](https://itunes.apple.com/us/app/id1162704202?mt=8)  

You can purchase it from App Store, or still use Potatso by building it manually and installing to your device from this project.



Please note that Potatso 2 will be closed-source as stated from original author's reason. Read more from [here](https://github.com/haxpor/Potatso/blob/master/ADHERE_LICENSE.md).



## Support Us



The development covers a lot of complicated work, costing not only money but also time.

These are the way to support



- [Download Potatso from Apple Store](https://itunes.apple.com/app/apple-store/id1070901416?pt=2305194&ct=potatso.github&mt=8). (**Recommended**) 

- Donate with Alipay to original author. (Account: **[email protected]**)

- Donate to swift3 maintainer (WeChat: http://imgur.com/lsAao62, or PayPal: [email protected])



## License



**You cannot just copy the project, and publish to App Store.**  Please read [this](https://github.com/haxpor/Potatso/blob/master/ADHERE_LICENSE.md) first.



--



To be compatible with those libraries using GPL, we're distributing with GPLv3 license.



This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.



This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.



You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.