Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgellci/Area51
Open source Reddit client for iOS built entirely in Swift
https://github.com/kgellci/Area51
ios ios-app ios-swift reddit reddit-client swift
Last synced: about 1 month ago
JSON representation
Open source Reddit client for iOS built entirely in Swift
- Host: GitHub
- URL: https://github.com/kgellci/Area51
- Owner: kgellci
- License: gpl-3.0
- Created: 2018-12-19T02:00:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-13T17:10:50.000Z (over 5 years ago)
- Last Synced: 2024-11-08T09:14:31.989Z (about 1 month ago)
- Topics: ios, ios-app, ios-swift, reddit, reddit-client, swift
- Language: Swift
- Size: 819 KB
- Stars: 144
- Watchers: 8
- Forks: 31
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- fucking-open-source-ios-apps - Area51 for Reddit
README
# Area51
[](https://travis-ci.org/kgellci/Area51)
Area51 is an open source Reddit client for iOS built entirely in Swift!
[**Get the public beta on TestFlight**](https://testflight.apple.com/join/V6vpApGX)
[**Join the public Slack channel to collaborate!**](https://join.slack.com/t/area51os/shared_invite/enQtNTE3NDM1NTc4NzcyLWZkMjkxMjA0ODA0ZTFjMTc4MzBmMjg3NDc4YjVmZjg0ZjI2MTkxOWE4YjAzNmU2ZTllMTBkZmUyZjU0OGM5OWI)
## Goals
- Provide a beginner friendly development environment
- Use the latest iOS development tools
- Document everything! Helps beginners learn :)
- Build an awesome open source Reddit client for iOS!
## Getting Started
### Requirements
Make sure you have Xcode: 10.2 or higher.
This project currently supports Swift 5.0+
### Setup
Clone the repo and run the generate command:
```console
git clone [email protected]:kgellci/Area51.git
cd Area51/
make generate
```
After `generate` is finished doing its job, open Area51.xcodeproj, build and run.
### Project Structure
Area51 does not import any 3rd party libraries in app.
[Xcodegen](https://github.com/yonaskolb/XcodeGen) is used for project definition and generation.
[Swiftlint](https://github.com/realm/SwiftLint) is used to keep the code properly structured and readable.
[Learn more about the project structure.](docs/project.md)
### Running on a device
Make sure you run `make generate` command from above to generate the appropriate config files.
Edit the `user.xcconfig` file in the `Configs/` directory (don't worry, it is gitignored!).
Set `DEVELOPMENT_TEAM` in the user.xcconfig file. Example:
`DEVELOPMENT_TEAM = XXXXXXXXX`
Edit the `bundleIdentifier.xcconfig` file in `Configs/` directory (also gitignored!).
Set `PRODUCT_BUNDLE_IDENTIFIER` in bundleIdentifier.xcconfig to something unique, Example:
`PRODUCT_BUNDLE_IDENTIFIER = whatever.i.want`
You will need to close the Xcode project, run `make generate` and open the project again.
You can find your team ID by logging into [developer.apple.com](developer.apple.com).
# FAQ
If you have more questions, check out the [FAQ](docs/faq.md). If your question is not answered, open a new issue with the "Question" tag.
# License
Area51 is licensed under the GNU General Public License v3.0. See [LICENSE](LICENSE) for more info.