Shortest

shortest.com

Local Development Setup Guide

This guide will help you set up the Shortest web app for local development.

Prerequisites

• Node.js
• pnpm

Getting Started

1. Clone the repository:

   git clone https://github.com/gumroad/shortest.git
   cd shortest

2. Install dependencies:

   npm install -g pnpm
   pnpm install

For Gumroad Vercel Team Members:

1. Run vercel env pull to get the latest environment variables
   • https://vercel.com/docs/deployments/local-env#environment-variables-for-local-development

For Other Contributors:

1. Run pnpm run setup to configure the environment variables.
2. The setup wizard will ask you for information. Refer to "Services Configuration" section below for more details.

Set up the database:

   pnpm drizzle-kit generate
   pnpm db:migrate
   pnpm db:seed # creates stripe products, currently unused

Services Configuration

You'll need to set up the following services for local development. If you're not a Gumroad Vercel team member, you'll need to either run the setup wizard pnpm run setup or manually configure each of these services and add the corresponding environment variables to your .env.local file:

Running the Application

Once you have set up the environment variables and installed dependencies, run the development server:

pnpm dev

Open http://localhost:3000 in your browser to see the app in action.

Running Tests

To run unit tests:

pnpm vitest

Setup Guide for Running and Building Shortest Package Locally

When running pnpm install in the root, the shortest package will be built and added in the node_modules folder. However, in order to use the cli, you need to setup the cli locally as follows:

to install shortest package

pnpm install

### Setup Shortest CLI
```bash
# packages/shortest
cd packages/shortest
pnpm link --global

# root
cd ../..
pnpm link --global shortest

Run Tests

You can either run tests using the shortest cli:

shortest

or use the pnpm command:

pnpm test

Test Github MFA Login Flow with Shortest

In order to test Github MFA login in browser you need to add register shortest as OTP provider and add the OTP secret to your .env.local file:

1. Go to your repo settings
2. Navigate to Password and Authentication
3. Click on Authenticator App
4. Choose Use your authenticator app
5. Click on Setup key to grab the OTP secret
6. Add the OTP secret to your .env.local file or use the shortest cli to add it:

shortest --github-code --secret=<OTP_SECRET>

7. Laslty enter the 2FA code generated in terminal in your Github Authenticator editor

To run tests in Github workflows

prerequisites:

• Add ANTHROPIC_API_KEY to your repo secrets
• Connect your repo to Vercel

To add ANTHROPIC_API_KEY to your repo secrets:

• Go to your repo settings
• Navigate to Security
• Click Add secret
• Add the ANTHROPIC_API_KEY environment variable