From 30573db606b93318fce1bc27e7f74233364034f1 Mon Sep 17 00:00:00 2001 From: Lee Date: Fri, 3 Nov 2023 13:35:36 +0100 Subject: [PATCH] refactor: updated readme Co-authored-by: Sebastian Palmqvist --- README.md | 4 - apps/skolplattformen-app/README-NEW.md | 102 ------------------------- apps/skolplattformen-app/README.md | 95 +++++++++-------------- 3 files changed, 35 insertions(+), 166 deletions(-) delete mode 100644 apps/skolplattformen-app/README-NEW.md diff --git a/README.md b/README.md index 41b760c6..5c912442 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@ The respective README files there contain more detailed descriptions. * [Architecture](#architecture) * [Apps](#apps) * [skolplattformen](#skolplattformen) - * [skolplattformen dependency upgrade](#skolplattformen-dependency-upgrade) * [website](#website) * [Libs](#embedded-api) * [api](#api) @@ -59,9 +58,6 @@ We're starting small, with more features being added over time. For more information, check out the [source code](apps/skolplattformen-app). -#### skolplattformen dependency upgrade -A dependency upgrade is currently in the works. To navigate directly to the related readme, click [here](/apps/skolplattformen-app-new/README-NEW.md). - #### website The code for the website at https://skolplattformen.org/. It's built using Next.js. diff --git a/apps/skolplattformen-app/README-NEW.md b/apps/skolplattformen-app/README-NEW.md deleted file mode 100644 index 3373ca77..00000000 --- a/apps/skolplattformen-app/README-NEW.md +++ /dev/null @@ -1,102 +0,0 @@ -# Skolplattformen React Native Project - -Welcome to this new [**React Native**](https://reactnative.dev) project, initiated using [`@react-native-community/cli`](https://github.com/react-native-community/cli). - -## Pre-requisites - -> **Important**: Make sure you have gone through the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) guide up to the "Creating a new application" step before moving forward. - -## Initial Setup - -### Required Software - -1. [Git](https://git-scm.com/) -2. [Node](https://nodejs.org/en/) -3. [NPM](https://docs.npmjs.com/cli/v8/commands/npm-install) - -### Minimum Node Version -Ensure you are using Node version 16 or higher. - -### Cloning the Repository - -```bash -git clone https://github.com/Home-Biz-LLS/skolplattformen-react-native -``` - -### Installing Dependencies - -```bash -cd apps/skolplattformen-app-new/ && npm i -``` - ---- - -## Running the App - -### For iOS - -**Note**: Running the iOS app requires a Mac with native support. Windows/Linux are currently not supported. - -#### Essential Guides and Tools - -* [Mac OS Setup Guide](https://reactnative.dev/docs/environment-setup) - -#### Step-by-Step Instructions - -1. **Install Xcode**: Ensure Xcode is installed on your system. - -2. **Install CocoaPods**: If not already installed, you can do this easily using Homebrew. - - [Homebrew Install Guide for CocoaPods](https://formulae.brew.sh/formula/cocoapods) - - [Official CocoaPods Guide](https://guides.cocoapods.org/using/getting-started.html) - -3. **Install Pods** - ```bash - cd apps/skolplattformen-app-new/ios && pod install - ``` - -#### Running the iOS App - - -* Option 1: Using Metro Bundler - - ![metro bundler example](/apps/skolplattformen-app-new/docs/assets/MetroBundlerExample.png) - ```bash - cd apps/skolplattformen-app-new && npm run start - ``` - then type - ```bash - i - ``` - -* Option 2: Running Directly - ```bash - npm run ios - ``` - ---- - -### For Android - -**Note**: Choose an appropriate guide based on your operating system: - -* [Mac OS](/apps/skolplattformen-app-new/docs/android_mac.md) -* [Windows](/apps/skolplattformen-app-new//docs/android_windows.md) -* [Linux](/apps/skolplattformen-app-new//docs/android_linux.md) - -#### Running the Android App - -* Option 1: Using Metro Bundler - - ![metro bundler example](/apps/skolplattformen-app-new/docs/assets/MetroBundlerExample.png) - ```bash - cd apps/skolplattformen-app-new && npm run start - ``` - then type - ```bash - a - ``` - -* Option 2: Running Directly - ```bash - npm run android - ``` \ No newline at end of file diff --git a/apps/skolplattformen-app/README.md b/apps/skolplattformen-app/README.md index f22bc1fc..2407f6a7 100644 --- a/apps/skolplattformen-app/README.md +++ b/apps/skolplattformen-app/README.md @@ -1,84 +1,59 @@ -This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli). +# Öppna skolplattformen App -# Getting Started +This is the app for Öppna skolplattformen. ->**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. +## Getting started -## Getting started with Development +Have a look at the [overall readme](../../) for general instructions on getting started. -### Please use node version 16 or higher +### Prerequisites -To clone and build the project, you first need to install [git](https://git-scm.com/), [node](https://nodejs.org/en/) and [npm](https://docs.npmjs.com/cli/v8/commands/npm-install). - -Clone the repo with -```bash -$ git clone https://github.com/Home-Biz-LLS/skolplattformen-react-native -``` - -Install dependencies -```bash -cd apps/skolplattformen-app-new/ && npm i -``` +We use `yarn` as our package manager. To install it, run `sudo npm install -g yarn`. All the commands described here should be run from the `packages/app` directory. ### iOS -If you wanna run the iOS app, you need to setup a couple of things first, we have a guide that will assist you in getting started with the iOS app. A Mac is required to build projects with native code for iOS so we do not have support for Linux / Windows. +To get started using the iOS simulator start by installing the JavaScript +dependencies using -* [Mac OS](https://reactnative.dev/docs/environment-setup) - -#### Step 1 -Make sure you have **Xcode** installed - - -#### Step 2 -Make sure **CocoaPods** is installed (you can do it easily with homebrew) - -* [CocoaPods homebrew](https://formulae.brew.sh/formula/cocoapods) -* [CocoaPods](https://guides.cocoapods.org/using/getting-started.html) - - -#### Step 3 ```bash -cd apps/skolplattformen-app-new/ios && pod install +$ yarn ``` -If you already setup everything, go into the +Next you need to install the [Cocoapods](https://cocoapods.org/) dependencies +for the iOS project -"skolplattformen-app-new" directory - -Start the metro - -``` -npm run start +```bash +$ cd ios +$ pod setup +$ pod install ``` -then +You should now be setup to run the app in the Simulator. Run the `ios` command +in the root of the app. +```bash +$ yarn ios ``` -i -``` -to Start iOS app - -OR - -Start the iOS app directly -``` -npm run ios -``` - - ### Android -If you wanna run the Android app, you need to setup a couple of things first, we have created three different guides depending on your operating system. +Android development requires that you have [Android Studio](https://developer.android.com/studio) and relevant build tools installed. -* [Mac OS](/docs/android_mac.md) -* [Windows](/docs/android_windows.md) -* [Linux](/docs/android_linux.md) +Start by installing JavaScript dependencies using -If you already setup everything, you just need to run the following command in the project root: - -``` -yarn run android +```bash +$ yarn ``` +Before running the app you should start an emulator from Android Studio. Then +run the following command to start the build + +```bash +$ yarn android +``` + +## Running tests + +```bash +$ yarn test +```