From f0600c5ec4ffa5a84f6a08c07ec341a22e0430de Mon Sep 17 00:00:00 2001 From: jdlugosz963 Date: Mon, 11 Dec 2023 15:31:21 +0100 Subject: Add README files. --- README.md | 137 ++++++++++++++++++++++++++----------------------------------- README.org | 53 ++++++++++++++++++++++++ 2 files changed, 111 insertions(+), 79 deletions(-) create mode 100644 README.org diff --git a/README.md b/README.md index 12470c3..981ad25 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,58 @@ -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 -``` - -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 R key twice or select **"Reload"** from the **Developer Menu** (Ctrl + M (on Window and Linux) or Cmd ⌘ + M (on macOS)) to see your changes! - - For **iOS**: Hit Cmd ⌘ + R 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. +# Jak uruchomic projekt ? + +- Android: + - Wymagania: + 1. Docker + - Kroki do wykonania na telefonie + 1. Wejdź do ustawień w telefonie i w zakładce \"Developer + options\" włącz opcję \"USB Debugging\" + 2. Podłącz telefon do komputera + - Kroki do wykonania na komputerze + 1. Przejść do projektu: + + ``` {.bash org-language="sh"} + cd cyberbadge_mobile + ``` + + 2. Sprawdzić czy urządzenie z androidem jest poprawnie + podłączone, możliwe będzie zaakceptowanie prośby o + podłączenie na telefonie. + + - **Note**: Jak będzie brakować uprawnień (u mnie było to + zbędne) można spróbować dodać regułkę do udeva, + dokładnie jest to opisanie tutaj: + + + ``` {.bash org-language="sh"} + ./dev-env adb devices + + # Poprawny output \/ + # * daemon not running; starting now at tcp:5037 + # * daemon started successfully + # List of devices attached + # 27141JEGR05136 device + ``` + + 3. Uruchomić projekt komenda podana poniżej: + + - **Note**: pierwsze uruchomienie będzie trwało długo (u + mnie to było kolo 30 minut). + + ``` {.bash org-language="sh"} + ./dev-env npm run start + ``` + + 4. Jak sie wszystko załaduję poprawnie powinna się ukazać ładna + grafika z napisem *Welcome to Metro*, w tym momencie należy + kliknąć literkę \"a\", aby uruchomić apkę na telefonie z + Androidem. + + 5. Jak się nic nie wysypie po drodze to apka powinna się + uruchomić sama na telefonie. + + 6. **NOTE**: Wszystkie operacje z **npm** powinny być + wykonywanie wewnątrz środowiska, czyli: + + ``` {.bash org-language="sh"} + ./dev-env npm [cokolwiek] + ``` diff --git a/README.org b/README.org new file mode 100644 index 0000000..9b7b842 --- /dev/null +++ b/README.org @@ -0,0 +1,53 @@ +#+TITLE: README + +* Jak uruchomic projekt ? +- Android: + + Wymagania: + 1. Docker + + + Kroki do wykonania na telefonie + 1. Wejdź do ustawień w telefonie i w zakładce "Developer options" włącz opcję "USB Debugging" + 2. Podłącz telefon do komputera + + + Kroki do wykonania na komputerze + 1. Przejść do projektu: + #+begin_src sh + cd cyberbadge_mobile + #+end_src + + 2. Sprawdzić czy urządzenie z androidem jest poprawnie podłączone, + możliwe będzie zaakceptowanie prośby o podłączenie na telefonie. + + - *Note*: Jak będzie brakować uprawnień (u mnie było to zbędne) + można spróbować dodać regułkę do udeva, dokładnie jest to + opisanie tutaj: + https://reactnative.dev/docs/running-on-device + + #+begin_src sh + ./dev-env adb devices + + # Poprawny output \/ + # * daemon not running; starting now at tcp:5037 + # * daemon started successfully + # List of devices attached + # 27141JEGR05136 device + #+end_src + + 3. Uruchomić projekt komenda podana poniżej: + - *Note*: pierwsze uruchomienie będzie trwało długo (u mnie to + było kolo 30 minut). + #+begin_src sh + ./dev-env npm run start + #+end_src + + 4. Jak sie wszystko załaduję poprawnie powinna się ukazać ładna + grafika z napisem /Welcome to Metro/, w tym momencie należy + kliknąć literkę "a", aby uruchomić apkę na telefonie z + Androidem. + + 5. Jak się nic nie wysypie po drodze to apka powinna się uruchomić sama na telefonie. + + 6. *NOTE*: Wszystkie operacje z *npm* powinny być wykonywanie wewnątrz środowiska, czyli: + #+begin_src sh + ./dev-env npm [cokolwiek] + #+end_src -- cgit v1.2.3