Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 2.73 KB

README.md

File metadata and controls

74 lines (59 loc) · 2.73 KB
Raw

CourseCoach

A way to conquer your Course.

A mobile app built using React Native, which provides course contents to B.Tech students.

Get the app

Release versions of the app are available here:

Screenshots

Development

Build and run the app

This guide describes how to build and run the app so you can develop it.

Main steps

Before starting, install these dependencies if you don't have them:

Then, run the commands below in your terminal:

git clone https://github.com/AdityHirapara/CourseCoach
cd CourseCoach
yarn install

To install the React Native tools, and either Xcode or the Android SDK and Android Studio, follow the helpful instructions from React Native upstream on Getting Started. You want the tab "Building Projects with Native Code"; the "Quick Start" does not apply.

Continue those instructions until you can run the CourseCoach app with either react-native run-android or react-native run-ios. You'll want to be able to use both an emulator and a physical device; but for starting out, just get either one working so you can play with the app.

Android tips

  • To set up the Android emulator, follow the heading "Using a virtual device" in those React Native Getting Started instructions.
  • After you set up the Android emulator, you no longer need Android Studio. You can start the emulator from the command line.
  • When running on a physical device, if the device has CourseCoach installed from the Play Store, you may need to uninstall that version first.
  • Commands once you've set up:
    • react-native run-android - build, then run on an active emulator or USB-connected device. This won't start the emulator automatically.