Commit f9ac0e6f authored by Sébastiaan Versteeg's avatar Sébastiaan Versteeg
Browse files

Update README and add yarn script shortcuts to package.json

parent 5561269b
...@@ -18,7 +18,7 @@ stages: ...@@ -18,7 +18,7 @@ stages:
eslint: eslint:
stage: validate stage: validate
script: script:
- yarn ci-lint - yarn lint:ci
jest: jest:
stage: validate stage: validate
[![BuddyBuild](]( Thalia Website
# ThaliApp ==============
The new and improved ThaliApp The new and improved ThaliApp
# Installation Android: [![BuddyBuild](](
## Requirements iOS: [![BuddyBuild](](
* [Node]( (Some package managers might ship versions that are too old)
* [Yarn](
* Android development environment set up according to [this guide]( Getting started
## Setup 0. Get at least the latest [Node]( LTS version
`yarn install` 1. Install the [Yarn]( package manager
2. Set up the Android (and/or if you're running macOS: iOS) development environment using [this guide](
3. Clone this repository
4. Run `yarn install` to get all the required dependencies
5. Start the development server using `yarn start`
6. Deploy the app on a running emulator or connected Android device by running `yarn start:android`
## Starting the app on your phone
Ensure that the development server is started with `yarn run react-native start`.
Deploy the app on a running emulator or connected Android Phone with `yarn run react-native run-android`.
## Starting the app in your browser Logging and debugging
Run `webpack` ---------------
Open index.html
## Debugging Reading the basic logs is easy, you can run `yarn log:android` or `yarn log:ios` to oen the standard log output in your terminal.
Open the console with `yarn run react-native log-android`. Follow [this guide]( for more advanced debugging.
...@@ -3,9 +3,16 @@ ...@@ -3,9 +3,16 @@
"version": "0.0.1", "version": "0.0.1",
"private": true, "private": true,
"scripts": { "scripts": {
"start": "node node_modules/react-native/local-cli/cli.js start", "start": "react-native start",
"start:ios": "react-native run-ios",
"start:android": "react-native run-android",
"log:ios": "react-native log-ios",
"log:android": "react-native log-android",
"lint": "eslint *.js app --fix", "lint": "eslint *.js app --fix",
"ci-lint": "eslint *.js app" "lint:ci": "eslint *.js app",
"test": "jest",
"test:watch": "jest --watch",
"coverage": "jest --coverage"
}, },
"jest": { "jest": {
"preset": "react-native", "preset": "react-native",
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment