/WhichCard

WhichCard mobile app

Primary LanguageTypeScript

WhichCard Front-End - NUS Orbital 2023

This project is developed using the React Native open-source UI software framework.

Getting started

Setting up your environment

  • Follow the official React Native CLI Quickstart documentation to setup your development environment.
  • As of this writing, this project uses Node.js LTS 18.16.0.

IMPORTANT (for iOS): A Mac is required to run and test iOS applications.

Cloning this repository

  • Follow the official Git installation documentation to install git on your system.

  • git clone https://github.com/RyanNgWH/WhichCard.git

    Clone this git repository.

Installing project dependencies

  • cd WhichCard

    Navigate into the cloned git repository.

  • npm install

    Install all required node package dependencies.

  • (for iOS)
    cd ios && pod install && cd ..

    Install iOS dependencies.

Running the app

The following commands should be executed from the root folder of this project.

  • (for iOS)
    npx react-native run-ios

    Build and run this application in the iOS simulator. This command also launches Metro Bundler in a new terminal.

  • (for Android)
    npx react-native run-android

    Build and run this application in the Android simulator. This command also launches Metro Bundler in a new terminal.