Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.04 KB

SETUP.md

File metadata and controls

88 lines (60 loc) · 2.04 KB

Setup

Pre-Commit

  1. Install pre-commit via either:
    • pip install pre-commit (requires pip and python to be installed), or
    • brew install pre-commit.
  2. Install the hooks: pre-commit install

iOS:

System prerequisites

Software Version
CocoaPods (Xcode CLI tools) N/A
node v16+
Xcode N/A

Setup steps

  1. Install prerequisites - Skip if already installed

    1. Install XCode via app store (This can take between 10 minutes to 3 hours).

    2. Install CocoaPods. This should be part of XCode command line tools.

      xcode-select --install
    3. Install node v16+

  2. Install npm packages

    cd <project_directory>/packages/chess.ts
    npm install
    cd <project_directory>/packages/TorneloScoreSheet
    npm link ../packages/chess.ts
    npm install
  3. Install iOS packages

    cd <project_directory>/ios
    pod install
    cd ..
  4. Run simulator

    1. Start Xcode

    2. Run the following in the terminal

      cd <project_directory>
      npm run ios

Android (WIP):

https://reactnative.dev/docs/running-on-device

Prerequisites:

Steps

  1. Install prerequisites:

    1. Android Debug Bridge

      https://developer.android.com/studio/command-line/adb

    2. Java runtime

      https://java.com/en/

    3. Android Development Environment (Android Studio)

      https://developer.android.com/studio/install

      https://developer.android.com/studio#downloads

      https://guides.codepath.com/android/installing-android-sdk-tools#installing-the-android-sdk-via-homebrew

    4. For mac users, add this to your ~/.bash_profile or ~/.zprofile or whatever environment you use:

      export ANDROID_SDK_ROOT=~/Library/Android/sdk

  2. Enable debugging over USB on android device

  3. Plug in USB and connect to device

  4. Run npm run android