Jelajahi Sumber

Updated README With Project setup

Savio Fernando 1 tahun lalu
induk
melakukan
080b79080d
2 mengubah file dengan 46 tambahan dan 76 penghapusan
  1. TEMPAT SAMPAH
      .github/newscout_text_light.png
  2. 46 76
      README.md

TEMPAT SAMPAH
.github/newscout_text_light.png


+ 46 - 76
README.md

@@ -1,79 +1,49 @@
-This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
 
 
-# Getting Started
-
->**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
-
-## Step 1: Start the Metro Server
-
-First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
-
-To start Metro, run the following command from the _root_ of your React Native project:
-
-```bash
-# using npm
-npm start
-
-# OR using Yarn
-yarn start
-```
-
-## Step 2: Start your Application
-
-Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
-
-### For Android
-
-```bash
-# using npm
-npm run android
-
-# OR using Yarn
-yarn android
-```
-
-### For iOS
-
-```bash
-# using npm
-npm run ios
-
-# OR using Yarn
-yarn ios
+   <div align="center">
+    <h1>
+		<br>
+		<a href="https://newscout.com">
+			<img src=".github/newscout_text_light.png" height="50">
+         <h3>Newscout Mobile Client<h3>
+		</a>
+	</h1>
+   </div>  
+
+## Table of Contents
+* [Project Setup](#project_setup)
+* [Project Description](#description)
+
+## Project Setup
+
+### Please refer to the [React Native Documentation](https://reactnative.dev/docs/environment-setup)
+
+1. Install [Node v18](https://www.liquidweb.com/kb/install-nvm-linux/)
+2. Install [Java JDK 17](https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-on-ubuntu-22-04)
+3. Install [Android Studio](https://www.educative.io/answers/how-to-install-android-studio-in-ubuntu)
+4. Clone Project from GOGS
+    ```bash 
+    git clone gogs@git.fafadiatech.com:savio/Newscout_Mobile.git
+    ```
+5. Check Dependancies by running 
+    ```bash 
+    npx react-native doctor
+    ```
+    **NOTE:** Please rectify the issues shown by RN Doctor before running the project.
+6. Install NPM Packages
+    ```bash 
+    npm install
+    ```
+7. For Debugging, Use an android device or emulator
+   1. For Android Device
+        1. Follow this guide for 
+            [Running on Device](https://reactnative.dev/docs/running-on-device)
+   2. For Emulator 
+        1. Install [KVM](https://phoenixnap.com/kb/ubuntu-install-kvm)
+        2. Create a Virtual Device with AVD Manager in Android Studio
+
+8. Run Project with 
+```bash 
+    npx react-native start
 ```
 ```
 
 
-If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
-
-This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
-
-## Step 3: Modifying your App
-
-Now that you have successfully run the app, let's modify it.
-
-1. Open `App.tsx` in your text editor of choice and edit some lines.
-2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes!
-
-   For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes!
-
-## Congratulations! :tada:
-
-You've successfully run and modified your React Native App. :partying_face:
-
-### Now what?
-
-- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
-- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
-
-# Troubleshooting
-
-If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
-
-# Learn More
-
-To learn more about React Native, take a look at the following resources:
-
-- [React Native Website](https://reactnative.dev) - learn more about React Native.
-- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
-- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
-- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
-- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
+## Project Description