LumenRoute

Set up instructions

Important

To clone the repository on your local device:

Recommended Steps:

1. Find a local folder on your laptop where you would like to store your project.
   • EX: Desktop, Download, etc.
2. Create a folder for Open Project with mkdir commend

   $ mkdir op
   

3. [Optional] Create a folder for LumenRoute

   $ mkdir lumenroute
   

4. Follow the steps bellow:

Clone Repository

1. Clone the remote repository with the url:

       $ git clone https://github.com/Jennyl51/LumenRoute
   

2. Change directory to the folder you just cloned with cd

   $ cd LumenRoute
   

3. [Optional] Check remote connections with:

   $ git remote -v
   

4. Pull all changes from the remote end

   $ git pull origin main
   

5. Download the data files from City of Berkeley Police Deparment Data Portal: https://bpd-transparency-initiative-berkeleypd.hub.arcgis.com/search or from the Data.zip shared in #lumenroute Slack Channel

6. Move the Data.zip to LumenRoute directory, and unzip the Data.zip

7. Make sure the datasets and csv file's names are matching with the shared code, please revise the name of the files on your local laptop instead of modifying the written code.

8. Never add or push the data file to github repository. Same for .env file which stores the API keys.

   • please add the file name to .gitignore before you push to github.

9. Move the Data folder under assests/, your directories should look like

LumenRoute/
        .expo/
        .vscode/
        app/
        assets/
            Data/          #moved to here, should be in gray color as it's untracked
            dummie-data/
            images/
        components/
        ...
        ...

Packages Install

1. Run "npm install" to install node_modules at the main directory

2. Run "npx expo start" to checkout the app!

   • Press "w" for website view
   • Download "EXPO GO" mobile app and Scan the QR with camera for mock mobile app view

3. Create .env file

   • Add personal API KEYs to the .env file, including:

       - EXPO_PUBLIC_GOOGLE_MAPS_API_KEY
       - GOOGLE_IOS_CLIENT_ID
       - GOOGLE_ANDROID_CLIENT_ID
   

backend Packages

1. Run the following commends to install libraries:

   $ pip install osmnx pandas numpy
   

Large Files

1. Download git command for large files:

    $ brew install git-lfs
    $ git lfs install                               #enable lfs
    $ git lfs track "*.csv"
    $ git rm --cached '*.csv'

2. Run this to enable larger push:

    git config http.postBuffer 524288000
    git config http.maxRequests 100
    git config pack.windowMemory "100m"
    git config pack.packSizeLimit "100m"

Git Workflow

1. Pull changes before editing

   $ git pull origin main

2. Create a new branch for your code:

   • EX: I created the map screen

       $ git checkout -b page/map_screen
   

   • Feel free to just create a branch with your name:
   • EX:

       $ git checkout -b jenny-code
   

3. Commit your changes:

   $ git add .                             #Tells the systems what files to push
   $ git commit -m"your message here"      #Commit the changes to local end

4. Push changes to your branch:

   git push origin branch_name             #Push changes to remote repo