Skip to content
nguyenvukhang edited this page Jan 17, 2022 · 2 revisions

The app source is hosted on a private repo. See Admin Page for access instructions.

Minimum requirements

  • A Github account
  • An Expo account
  • node v16
  • yarn v1
  • git
  • A physical iOS/Android device with Expo Go installed
  • secrets.json (get it from a project member)

Instructions on how to install these can be found here.

Getting started

Universal steps

  • first clone
    1. (optional) create working directory
    2. clone the repo locally
    3. install yarn packages
    4. copy secrets.json into the project root
  • after each fetch/pull
    1. update yarn pacakges
  • building and running
    1. go to project directory
    2. run expo start

Mac

First clone

Create a working directory and go to it

mkdir ~/sunnus && cd ~/sunnus

Clone the repository

git clone git@github.com:sunnustech/app.git

Go into the newly created directory and install all necessary dependencies

cd ~/sunnus/app && yarn

Copy the secrets.json file into the root directory of the project. (Same location as example.secrets.json)

cp /path/to/secrets.json ~/sunnus/app/secrets.json

After fetching updates from github

cd ~/sunnus/app && yarn

To run the app on a local server, run this command from anywhere under the app directory

expo start

Windows

Check that npm/yarn and expo are installed with path variables set.

  • If needed, download emulators to run on such as Expo Go.
  • To init and run, type expo start in your terminal to run.

Clone this wiki locally