The following README will contain all necessary information for new developers and additional resources to guide development.
The Reflector mobile application allows users to view articles posted on The Reflector official website. This project uses RSS Feeds from the website to scrape and present data. The RSS feeds are derived from BloxCMS and documentation can for here on how to use it.
Develop a quality-focused app that focuses on simplicity and stability while maintaining a strong code base with detailed documentation within the project. With this goal in mind, we can ensure that future developers will have an easy time jumping in given the simplicity, proper design architecture, and detailed documentation.
- User is greeted with the latest articles from the [ Reflector News tab ] and can tap on an article to view the full content of the tapped article.
- User can select a category to filter for articles in the tapped category. Categories may include Sports, News, Entertainment, etc. (The tabs that are shown on the Reflector Website
Note: Features are subject to change. Features are based on order of importance.
- Language: Swift 5.3
- User Interface Framework: SwiftUI
- Supported Devices: iOS 14.0 or later.
None for now. Hooray!
Note: All dependencies must be managed using Swift Package Manager. For future developers, do your absolute best to only use SPM if you have to add dependencies.
ReflectorIOS.paw can be opened using the Paw API software tool. If you've never used a tool like this, what it does is lets to make a GET,POST, etc. request to a URL and then it shows you the response. It's super helpful! A Windows alternative to Paw is Postman.
GUIDE.md is a markdown document meant for developers and will act as a guide to maneuver the project and its classes. New developers to the team are highly encouraged to read through this living document.