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.

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

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
```
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