Skip to main content

How to install dependencies

There are a few necessary steps to complete before running the project locally. This guide will walk you through the process 🚶‍♀️

Set up npm credentials​

Blueprint makes use of private npm packages. To have access to these, we set the necessary authToken in the .npmrc file locally, and in Vercel we make use of the shared global environment variable, so that if we need to rotate this token, it's done once for all projects that use it.

  1. Duplicate the .npmrc.example file and rename it to .npmrc at the root of the project.
  2. Copy the token stored as NPMJS - Global NPM Tokens in 1Password and paste it as the value for //registry.npmjs.org/:\_authToken=.

Make sure you have node v20.11.0 installed.​

There is a .nvmrc in the repo, so you can run nvm use to make sure you're using the right version.

Install dependencies​

First enable corepack (if you haven't already) by running:

corepack enable

You'll have to do this once every time you use a node version for the first time.

Then run:

pnpm i

Build local packages​

Before running the apps, you need to build the local packages. Run:

pnpm build:packages

Run pnpm build:packages every time you make changes to a package that needs to be built (for example: /packages/utils) and want to see those changes in the apps. Alternatively, if something isn't working as expected when you try to run any of the apps after pulling the latest changes from main, try running pnpm build:packages to see if that fixes the issue.

You should now be ready to run your apps locally!