Skip to content
This repository has been archived by the owner on Dec 24, 2018. It is now read-only.

RiseCareerAcademy/Rise

Repository files navigation

CircleCI Coverage Status

Rise

logo

Table of contents generated with markdown-toc

Demoing (Projects Ready for Testing)

  1. Install Expo app on Android or iOS

  2. Login on the Expo app using the following account:

    Username: kmui2
    Password: Rise@2018
    
  3. Scan QR code here on the camera app for iOS or on the Expo app for Android

  4. Server Debugging: Open http://104.248.57.156:8080/#/streams/Rise.

Development

Git (If Not Already Installed)

  1. https://git-scm.com/
  2. Setup username: https://help.github.com/articles/setting-your-username-in-git/
  3. Setup email: https://help.github.com/articles/setting-your-commit-email-address-in-git/

VSCode

  1. Install VSCode
  2. Open VSCode
  3. Open VSCode's terminal
    • Cmd/Ctrl+ Shift + P then type >Terminal

Node.js

  1. Install Node Version Manager (nvm)

    Mac OSX

    curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
    
    export NVM_DIR="${XDG_CONFIG_HOME/:-$HOME/.}nvm"
    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

    Windows

    Run the .exe file in nvm-setup.zip.

  2. Install latest Node.js version:

    nvm install 10.11.0 

Setup the Rise Repo

  1. Clone the repo

    git clone https://github.com/RiseMentors/Rise.git
  2. Go to the repo

    cd Rise
  3. Install dependencies

    npm install
    
     # if there is a cb() never called! error, verify the cache:
     npm cache verify
  4. Start server

    npm run serve
    
    # If you have the Gmail password for automated emails:
    GMAIL_PASSWORD="<password>" npm run serve
  5. Start app

    # Mac OSX
    npm start 
    
    #Windows
    npm install -g expo-cli # Only need to install this once.
    expo start 
  6. Install Expo app on Android or iOS

  7. Scan QR code on the camera app for iOS or on the Expo app for Android.

Set up Postman and local server

In order to fully run Rise on expo, one must also have a local server. Here are instructions to get you started: https://docs.google.com/document/d/1qTC6WCncEo7d6_XF3DdekR6pyNq37f7atdX5i14J3xI/edit?usp=sharing

This will allow you to find a matching mentor that is pre-populated in the database.

Folder Structure

Rise
β”œβ”€β”€ assets            # fonts and images
β”œβ”€β”€ components        # components
β”œβ”€β”€ config            # database configurations
β”œβ”€β”€ constants         # constants for styling and types
β”œβ”€β”€ navigation        # screen and tabs react-naviagtion
β”œβ”€β”€ public            # for getting SSL certificate by rendering an HTML template
β”œβ”€β”€ routes            # api routes with controllers and models
β”œβ”€β”€ screens           # mobile screens composed of components
|
β”œβ”€β”€ server.js         # handles the middleware and routes to the routes folder
β”œβ”€β”€ App.js            # container for all the screens
└── package.json      # lists all the dependencies and npm scripts

* Do not touch this file!

About

πŸ™‹:iphone: An App to Help Find Mentors for Inner City Students

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages