Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 3.03 KB

README.md

File metadata and controls

69 lines (49 loc) · 3.03 KB
Raw

Bread and Roses Presents

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 node and pnpm:

node -v
pnpm -v

We strongly recommend using a Node version manager like nvm (for Mac) or nvm-windows (for Windows) to install Node.js. If you don't plan on switching between different Node versions, you can alternatively get a prebuilt installer from the Node.js website for an easier approach. Make sure to get Node version 18 and up, the latest LTS version should be sufficient.

After installing Node, you most likely have npm installed as well (check by running npm -v). If you have npm installed, simply run npm install -g pnpm to install pnpm. If your command line does not recognize npm as a command, refer to this article to troubleshoot.

Additional resources:

Installation

  1. Clone the repo & install dependencies

    1. Clone this repo
      • using SSH (recommended) 
        git clone git@github.com:calblueprint/bread-and-roses.git
      • using HTTPS 
        git clone https://github.com/calblueprint/bread-and-roses.git
    2. Enter the cloned directory 
      cd bread-and-roses
    3. Install project dependencies. This command installs all packages from package.json. 
      pnpm install

  2. Set up secrets:

    1. In the project's root directory (bread-and-roses), 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

Development environment

  • VSCode (recommended)
    1. Open the bread-and-roses 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:

pnpm dev

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