skolplattformen-backup/apps/skolplattformen-app/README.md

60 lines
1.2 KiB
Markdown
Raw Normal View History

2021-08-31 19:54:56 +00:00
# Öppna skolplattformen App
2020-12-05 23:18:01 +00:00
2021-04-18 19:31:22 +00:00
This is the app for Öppna skolplattformen.
2020-12-05 23:18:01 +00:00
2021-04-18 19:31:22 +00:00
## Getting started
Have a look at the [overall readme](../../) for general instructions on getting started.
2020-12-05 23:18:01 +00:00
2021-02-17 08:50:42 +00:00
### Prerequisites
2020-12-05 23:18:01 +00:00
2021-04-18 19:31:22 +00:00
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.
2020-12-16 20:27:59 +00:00
2021-02-17 08:50:42 +00:00
### iOS
2020-12-16 20:27:59 +00:00
2021-02-17 08:50:42 +00:00
To get started using the iOS simulator start by installing the JavaScript
dependencies using
2021-04-18 19:31:22 +00:00
```bash
2021-02-17 08:50:42 +00:00
$ yarn
```
Next you need to install the [Cocoapods](https://cocoapods.org/) dependencies
for the iOS project
2021-04-18 19:31:22 +00:00
```bash
2021-02-17 08:50:42 +00:00
$ cd ios
$ pod setup
$ pod install
```
You should now be setup to run the app in the Simulator. Run the `ios` command
in the root of the app.
2021-04-18 19:31:22 +00:00
```bash
2021-02-17 08:50:42 +00:00
$ yarn ios
```
### Android
2021-04-18 19:31:22 +00:00
Android development requires that you have [Android Studio](https://developer.android.com/studio) and relevant build tools installed.
2021-02-17 08:50:42 +00:00
Start by installing JavaScript dependencies using
2021-04-18 19:31:22 +00:00
```bash
2021-02-17 08:50:42 +00:00
$ yarn
```
Before running the app you should start an emulator from Android Studio. Then
run the following command to start the build
2021-04-18 19:31:22 +00:00
```bash
2021-02-17 08:50:42 +00:00
$ yarn android
```
## Running tests
2021-04-18 19:31:22 +00:00
```bash
2021-02-17 08:50:42 +00:00
$ yarn test
```