README.md

SafeDep Platform Frontend

Development

Prerequisites

Note: You can skip ASDF setup if you already have the required version of nodejs installed on your system. Look at .tool-versions file to see the required version and other required tools.

• ASDF
• Install the required version of nodejs using asdf:

asdf install

Setup

• Configure buf schema registry

pnpm config set @buf:registry https://buf.build/gen/npm/v1/

• Install npm dependencies:

pnpm install

Buf SDK Update

When new version of API is published we need to update the SDK version in this application. We have a weird issue with pnpm where versions like ^1.10.0-20250203053921-75ead1519f84.1 in package.json are converted into 1.10.0-20250203053921-75ead1519f84.1 by pnpm update. To update Buf SDK, perform the following

• Apply a ^ for buf SDK packages

-    "@buf/safedep_api.bufbuild_es": "1.10.0-20250203053921-75ead1519f84.1",
-    "@buf/safedep_api.connectrpc_es": "1.6.1-20250203053921-75ead1519f84.2",
+    "@buf/safedep_api.bufbuild_es": "^1.10.0-20250203053921-75ead1519f84.1",
+    "@buf/safedep_api.connectrpc_es": "^1.6.1-20250203053921-75ead1519f84.2",

• Run the following commands

pnpm install
pnpm update @buf/safedep_api.bufbuild_es @buf/safedep_api.connectrpc_es

Configuration

• Create .env.local file based on env.local.sample (example)
• Update .env.local with the appropriate values

Note: For SafeDep Team members, ask for development credentials in Slack

Running the development server

• Start the development server:

pnpm dev

• Navigate to http://localhost:3000 in your browser.

Testing

• Run the test suite:

pnpm test

Framework Documentation

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.
• This project uses next/font to automatically optimize Geist, a new font family for Vercel.