Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sameersyd/boxfeed

News App 📱 built to demonstrate the use of SwiftUI 3 features, Async/Await, CoreData and MVVM architecture pattern.
https://github.com/sameersyd/boxfeed

codeable coredata figma hacktoberfest ios ios15 material-design mvvm mvvm-architecture news newsapi newsapp sameersyd swift swiftui swiftui3 ui-design xcode

Last synced: 3 months ago
JSON representation

News App 📱 built to demonstrate the use of SwiftUI 3 features, Async/Await, CoreData and MVVM architecture pattern.

Awesome Lists containing this project

README

        

![GitHub Cards Preview](https://github.com/sameersyd/BoxFeed/blob/main/art/cover.png?raw=true)

# Box Feed
News App 📱 built to demonstrate the use of following features,

- SwiftUI 3
- Async/Await
- AsyncImage
- List
- Refreshable
- Swipe Actions
- Separator
- Core Data
- MVVM Architecture Pattern

*Made with love ❤️ by [Sameer Nawaz](https://github.com/sameersyd)*


## Preview
Home | Article | Bookmarks
--- | --- | ---
![](https://github.com/sameersyd/BoxFeed/blob/main/art/home.png) | ![](https://github.com/sameersyd/BoxFeed/blob/main/art/article.png) | ![](https://github.com/sameersyd/BoxFeed/blob/main/art/bookmarks.png)


## Note
Once you clone the repo,
- Add your own API key from [News API](https://newsapi.org) in [AppConfig file](https://github.com/sameersyd/BoxFeed/blob/5b05981c0b476b7bd6c190134aa563e17143c933/BoxFeed/Config.swift#L16)
- Checkout your current plan. The [News API](https://newsapi.org) has limit for developer plan on dates query and content chars


## Built With 🛠
- [SwiftUI](https://developer.apple.com/documentation/swiftui/) - SwiftUI is an innovative, exceptionally simple way to build user interfaces across all Apple platforms with the power of Swift.
- [CoreData](https://developer.apple.com/documentation/coredata) - Framework used to manage the model layer objects in the application.
- [Figma](https://figma.com/) - Figma is a vector graphics editor and prototyping tool which is primarily web-based.


## Project Structure

BoxFeed # Target
|
├── Resources
|
├── Library
| ├── CoreData # CoreData ManagedObject
| ├── Helpers # All extension functions + CustomViews
| ├── Models # Decodable models
| ├── Services # NewsService
|
├── Screens
| |
| ├── view
| │ ├── main # Main root folder
| | │ ├── view # SwiftUI MainView
| | │ └── viewmodel # ViewModel for MainView
| │ ├── Home # Home root folder
| | | |__ Home # Home
| │ ├── Article # Article root folder
| | | |__ Article # Article
| │ ├── Bookmarks # Bookmarks root folder
| | | |__ Bookmarks # Bookmarks
|


## Contribute
If you want to contribute to this app, you're always welcome!
See [Contributing Guidelines](https://github.com/sameersyd/BoxFeed/blob/main/CONTRIBUTION.md).


## Donation
If this project helped you reduce time to develop, you can buy me a cup of coffee :)


Buy Me A Coffee

## License
```
Apache 2.0 License

Copyright 2021 Sameer Nawaz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

```