|
| 1 | + |
| 2 | + |
| 3 | +# Box Feed |
| 4 | +News App 📱 built to demonstrate the use of following features, |
| 5 | + |
| 6 | +- SwiftUI 3 |
| 7 | + - Async/Await |
| 8 | + - AsyncImage |
| 9 | + - List |
| 10 | + - Refreshable |
| 11 | + - Swipe Actions |
| 12 | + - Separator |
| 13 | +- Core Data |
| 14 | +- MVVM Architecture Pattern |
| 15 | + |
| 16 | +*Made with love ❤️ by [Sameer Nawaz](https://github.com/sameersyd)* |
| 17 | + |
| 18 | +<br /> |
| 19 | + |
| 20 | +## Preview |
| 21 | +Home | Article | Bookmarks |
| 22 | +--- | --- | --- |
| 23 | + |  |  |
| 24 | + |
| 25 | +<br /> |
| 26 | + |
| 27 | +## Built With 🛠 |
| 28 | +- [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. |
| 29 | +- [CoreData](https://developer.apple.com/documentation/coredata) - Framework used to manage the model layer objects in the application. |
| 30 | +- [Figma](https://figma.com/) - Figma is a vector graphics editor and prototyping tool which is primarily web-based. |
| 31 | + |
| 32 | +<br /> |
| 33 | + |
| 34 | +## Project Structure |
| 35 | + |
| 36 | + BoxFeed # Target |
| 37 | + | |
| 38 | + ├── Resources |
| 39 | + | |
| 40 | + ├── Library |
| 41 | + | ├── CoreData # CoreData ManagedObject |
| 42 | + | ├── Helpers # All extension functions + CustomViews |
| 43 | + | ├── Models # Decodable models |
| 44 | + | ├── Services # NewsService |
| 45 | + | |
| 46 | + ├── Screens |
| 47 | + | | |
| 48 | + | ├── view |
| 49 | + | │ ├── main # Main root folder |
| 50 | + | | │ ├── view # SwiftUI MainView |
| 51 | + | | │ └── viewmodel # ViewModel for MainView |
| 52 | + | │ ├── Home # Home root folder |
| 53 | + | | | |__ Home # Home |
| 54 | + | │ ├── Article # Article root folder |
| 55 | + | | | |__ Article # Article |
| 56 | + | │ ├── Bookmarks # Bookmarks root folder |
| 57 | + | | | |__ Bookmarks # Bookmarks |
| 58 | + | |
| 59 | + |
| 60 | +<br /> |
| 61 | + |
| 62 | +## Contribute |
| 63 | +If you want to contribute to this app, you're always welcome! |
| 64 | +See [Contributing Guidelines](https://github.com/sameersyd/BoxFeed/blob/main/CONTRIBUTION.md). |
| 65 | + |
| 66 | +<br /> |
| 67 | + |
| 68 | +## Donation |
| 69 | +If this project helped you reduce time to develop, you can buy me a cup of coffee :) |
| 70 | + |
| 71 | +<br /> |
| 72 | + |
| 73 | +<a href="https://www.buymeacoffee.com/sameersyd" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a> |
| 74 | + |
| 75 | +## License |
| 76 | +``` |
| 77 | + Apache 2.0 License |
| 78 | +
|
| 79 | +
|
| 80 | + Copyright 2021 Sameer Nawaz |
| 81 | +
|
| 82 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 83 | + you may not use this file except in compliance with the License. |
| 84 | + You may obtain a copy of the License at |
| 85 | +
|
| 86 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 87 | +
|
| 88 | + Unless required by applicable law or agreed to in writing, software |
| 89 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 90 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 91 | + See the License for the specific language governing permissions and |
| 92 | + limitations under the License. |
| 93 | +
|
| 94 | +``` |
0 commit comments