|
|
@@ -1,13 +1,13 @@
|
|
|
|
|
|
- <div align="center">
|
|
|
- <h1>
|
|
|
- <br>
|
|
|
- <a href="https://newscout.com">
|
|
|
- <img src=".github/newscout_text_light.png" height="50">
|
|
|
- </a>
|
|
|
- <h1>Newscout Mobile Client<h1>
|
|
|
- </h1>
|
|
|
- </div>
|
|
|
+<div align='center'>
|
|
|
+ <img align="center" src=".github/newscout_text_light.png" height="50">
|
|
|
+</div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+----
|
|
|
+
|
|
|
+
|
|
|
|
|
|
## Table of Contents
|
|
|
* [Project Setup](#project-setup)
|
|
|
@@ -88,7 +88,7 @@ TBD
|
|
|
5. `utils`: Contain Utility Functions
|
|
|
6. `context`: Contain App Context Files like Theme and Auth. This helps us aggregate the context data accessible from a single point.
|
|
|
7. `navigation`: Contain Logic to navigate across the screens.
|
|
|
- 8. `screens`: Contains All Pages for the App. Each File represents a Page for the Application. Pages are segregated by their [features/ function](https://www.antit.io/tech-blog/by-feature-approach-scaffolding-react-native)
|
|
|
+ 8. `screens`: Contains All Pages for the App. Each File represents a Page for the Application. Pages are segregated by their [features / function](https://www.antit.io/tech-blog/by-feature-approach-scaffolding-react-native)
|
|
|
|
|
|
## Core APIs
|
|
|
|
|
|
@@ -453,8 +453,8 @@ Please refer the [`data`](src/api/data.js) for API Functions.
|
|
|
|
|
|
### Pre-requisites
|
|
|
|
|
|
-* [React Navigation]()
|
|
|
-* [React Native Paper]()
|
|
|
+* [React Navigation](https://reactnavigation.org/)
|
|
|
+* [React Native Paper](https://reactnativepaper.com/)
|
|
|
|
|
|
### Key Components / Screens:
|
|
|
|
|
|
@@ -464,8 +464,8 @@ Please refer the [`data`](src/api/data.js) for API Functions.
|
|
|
### Creating a Component/Screen from Scratch
|
|
|
|
|
|
**Recommended:** When using VSCode for development, Please use these VSCode Extensions
|
|
|
-* [React Native Tools]() for Debugging
|
|
|
-* [ES7+ React/React Native Snippets]() for Code Snippets Shortcuts
|
|
|
-* [Javascript Docstrings]() for Code Commenting for JS
|
|
|
+* [React Native Tools](https://marketplace.visualstudio.com/items?itemName=msjsdiag.vscode-react-native) for Debugging
|
|
|
+* [ES7+ React/React Native Snippets](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets) for Code Snippets Shortcuts
|
|
|
+* [Javascript Docstrings](https://marketplace.visualstudio.com/items?itemName=Massi.javascript-docstrings) for Code Commenting for JS
|
|
|
|
|
|
**Example:** [News Detail Page](src/screens/News/NewsDetailPage.js)
|
