Skip to content

calblueprint/chinese-newcomers

Repository files navigation

Chinese Newcomers Service Center

This project is designed and developed by a team of UC Berkeley students through one of Cal Blueprint's project teams during the 2022-23 academic year.

Learn more about Chinese Newcomers Service Center and Cal Blueprint.


Getting Started

Prerequisites

Check your installation of npm and node:

node -v
npm -v

This project requires node version 16.17.0.

We strongly recommend using a Node version manager like nvm (for Mac) or nvm-windows (for Windows) to install Node.js and npm. See Downloading and installing Node.js and npm.

Installation

  1. Clone the repo & install dependencies
    1. Clone this repo
      • using SSH (recommended)
        git clone [email protected]:calblueprint/chinese-newcomers.git
      • using HTTPS
        git clone https://github.com/calblueprint/chinese-newcomers.git
    2. Enter the cloned directory
      cd chinese-newcomers
    3. Install Typescript:
      npm install -g typescript
    4. Install yarn:
      npm install -g yarn
    5. Install project dependencies. This command installs all packages from yarn.lock.
      yarn install
  2. Set up secrets:
    1. In the project's root directory (chinese-newcomers/), create a new file named .env
      touch .env
    2. Copy the credentials from Blueprint's internal Notion (access is required) and paste them into the .env file.

Helpful resources

Development environment

  • VSCode (recommended)
    1. Open the chinese-newcomers project in VSCode.
    2. Install recommended workspace VSCode extensions. You should see a pop-up on the bottom right to "install the recommended extensions for this repository".

Running the app

  1. In the project directory, run:
     expo start
  2. To test the app:
    • Expo Go (Recommended): download Expo Go on your phone, connect to same network as your laptop, and use your phone camera to scan the QR code displayed in the command line.
    • iOS Simulator: see Expo docs
    • Android Emulator: see Expo docs

Troubleshooting

Starting the expo app results in `FirebaseError: Firebase: Error (auth/invalid-api-key)` but .env exists with the correct credentials.

For whatever reason, sometimes the env variables don't get picked up, but adding the following line to firebaseApp.ts usually fixes it.

console.log(firebaseConfig);

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published