Immigration Justice Project

This project is being built by a team at Blueprint, a student organization at the University of California, Berkeley building software pro bono for nonprofits.

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/immigration-justice-project.git

      • using HTTPS

        git clone https://github.com/calblueprint/immigration-justice-project.git

   2. Enter the cloned directory

      cd immigration-justice-project

   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 (immigration-justice-project/), create a new file named .env.local
   2. Copy the credentials from Blueprint's internal Notion (access is required) and paste them into the .env.local file.

Helpful resources

• GitHub: Cloning a Repository
• GitHub: Generating SSH keys

Development environment

• VSCode (recommended)
  1. Open the immigration-justice-project 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

In the project directory, run:

 npm run dev

Then, navigate to http://localhost:3000 to launch the web application.