Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apriakhin/shadowsocks-client
Cross-platform lightweight client for Shadowsocks for macOS, iPadOS and iOS
https://github.com/apriakhin/shadowsocks-client
shadowsocks swift swiftdata swiftui tun2socks xcode
Last synced: 3 months ago
JSON representation
Cross-platform lightweight client for Shadowsocks for macOS, iPadOS and iOS
- Host: GitHub
- URL: https://github.com/apriakhin/shadowsocks-client
- Owner: apriakhin
- License: mit
- Created: 2024-07-02T21:57:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-16T11:21:02.000Z (6 months ago)
- Last Synced: 2024-09-25T21:20:46.580Z (4 months ago)
- Topics: shadowsocks, swift, swiftdata, swiftui, tun2socks, xcode
- Language: Swift
- Homepage:
- Size: 2.31 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Shadowsocks Client
Cross-platform lightweight client for Shadowsocks for macOS, iPadOS and iOS
Explore the docs »
TestFlight
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Shadowsocks Client is your ideal tool for secure and anonymous web surfing. This lightweight yet powerful application allows you to easily manage your Shadowsocks servers and connections. Enjoy fast and convenient internet access with our key features.
Key Features:
- Server Connection: Quickly connect to your Shadowsocks servers for instant internet access.
- Server Management: Add and edit servers using configurations, URLs, or by scanning QR codes.
- Easy Connection Management: Control your connections with Shortcuts for greater flexibility and control.
### Built With
* [![Swift][Swift]][Swift-url]
* [![SwiftUI][SwiftUI]][SwiftUI-url]
* [![SwiftData][SwiftData]][SwiftData-url]
## Getting Started
### Prerequisites
* Xcode 15.4
### Installation
1. Clone the repo
```sh
git clone [email protected]:apriakhin/shadowsocks-client.git
```
2. Open `ShadowsocksClient.xcodeproj`
3. Start project
## Usage
You need your own or a public Shadowsocks server, you can use a access key or config to connect to the server. After adding a server, you can connect in one-touch, and you can set up automation via Shortcuts.
## Roadmap
- [x] Add basic management of servers
- [x] Add connecting to the server
- [x] Add deeplink support for QR
- [x] Add app intents support
- [ ] Add menubar for macOS
- [ ] Add unit tests
- [ ] Multi-language support
- [x] English
- [x] Russian
- [x] Chinese
- [ ] German
- [ ] Spanish
- [ ] French
See the [open issues](https://github.com/apriakhin/shadowsocks-client/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Anton Priakhin - [@apriakhin](https://t.me/apriakhin) - [email protected]
Project Link: [https://github.com/apriakhin/shadowsocks-client](https://github.com/apriakhin/shadowsocks-client)
## Acknowledgments
* [Shadowsocks](https://shadowsocks.org)
* [Tun2socks](https://github.com/xjasonlyu/tun2socks)
* [outline-apps](https://github.com/Jigsaw-Code/outline-apps/tree/master)
* [outline-go-tun2socks](https://github.com/Jigsaw-Code/outline-go-tun2socks)
[contributors-shield]: https://img.shields.io/github/contributors/apriakhin/shadowsocks-client.svg?style=for-the-badge
[contributors-url]: https://github.com/apriakhin/shadowsocks-client/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/apriakhin/shadowsocks-client.svg?style=for-the-badge
[forks-url]: https://github.com/apriakhin/shadowsocks-client/network/members
[stars-shield]: https://img.shields.io/github/stars/apriakhin/shadowsocks-client.svg?style=for-the-badge
[stars-url]: https://github.com/apriakhin/shadowsocks-client/stargazers
[issues-shield]: https://img.shields.io/github/issues/apriakhin/shadowsocks-client.svg?style=for-the-badge
[issues-url]: https://github.com/apriakhin/shadowsocks-client/issues
[license-shield]: https://img.shields.io/github/license/apriakhin/shadowsocks-client.svg?style=for-the-badge
[license-url]: https://github.com/apriakhin/shadowsocks-client/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/apriakhin
[Swift]: https://img.shields.io/badge/swift-F05138?style=for-the-badge&logo=swift&logoColor=white
[Swift-url]: https://www.swift.org
[SwiftUI]: https://img.shields.io/badge/swiftui-1E88E5?style=for-the-badge&logo=swift&logoColor=white
[SwiftUI-url]: https://developer.apple.com/xcode/swiftui/
[SwiftData]: https://img.shields.io/badge/swiftdata-gray?style=for-the-badge&logo=swift&logoColor=white
[SwiftData-url]: https://developer.apple.com/xcode/swiftdata/