Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 3.46 KB

README.md

File metadata and controls

84 lines (59 loc) · 3.46 KB
Raw

Girls Write Now

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

Learn more about Girls Write Now and Cal Blueprint.

App Preview

Story Search/Filtering

Simulator.Screen.Recording.-.iPhone.15.-.2024-04-26.at.00.08.03.mp4

Story Recommendation

Simulator Screen Recording - iPhone 15 - 2024-04-25 at 14 09 19

Saving/Favoriting Stories

saved stories

Reacting To Stories

reactions

Getting Started

Prerequisites

Check your installation of npm and node:

node -v
npm -v

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 git@github.com:calblueprint/girls-write-now.git
      • using HTTPS 
        git clone https://github.com/calblueprint/girls-write-now.git
    2. Enter the cloned directory 
      cd girls-write-now
    3. Install project dependencies. This command installs all packages from package.json. 
      npm install
  2. Set up secrets:
    1. In the project's root directory (girls-write-now/), create a new file named .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 girls-write-now 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: 
     npx expo start
  2. There are several ways 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.
    • Web: typing w into the expo command line opens the app in a web view.
      • Warning: since the app is designed to be used on a mobile app, web compatibility might be limited, and some functionality might be different when using the web setup.