Installation & Setup

This guide walks you through setting up the Kai-Sign Builder development environment for local development, testing, and contributing to the codebase.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher) - Download

• Python 3.12 or higher - Download

• npm or yarn package manager

Quick Start

1. Clone the Repository

git clone https://github.com/Kai-Sign/Kai-Sign-Builder.git
cd Kai-Sign-Builder

2. Install Dependencies

npm install

3. Set Up Python Environment

The backend uses Python with FastAPI. Set up the virtual environment:

npm run setup-venv

This script:

• Creates a Python virtual environment in backend/venv/

• Installs required Python packages

• Configures the development environment

4. Configure Environment Variables

Create a .env file in the project root:

cp .env.example .env

Edit the .env file with your configuration:

# Backend Configuration (for local development)
ALCHEMY_RPC_URL=your_alchemy_rpc_endpoint
KAISIGN_CONTRACT_ADDRESS=0x4dFEA0C2B472a14cD052a8f9DF9f19fa5CF03719
ETHERSCAN_API_KEY=your_etherscan_api_key
USE_MOCK=false

# Frontend Configuration
NEXT_PUBLIC_API_URL=http://localhost:8000
NEXT_PUBLIC_KAISIGN_CONTRACT_ADDRESS=0x4dFEA0C2B472a14cD052a8f9DF9f19fa5CF03719

5. Start Development Server

Launch both frontend and backend:

npm run dev

This starts:

• Frontend: Next.js app at http://localhost:3000

• Backend: FastAPI server at http://localhost:8000

Configuration Options

Local Development (Default)

For most development work, use the local setup:

npm run dev

Both frontend and backend run locally with hot reload enabled.

Using Remote Backend

To use a deployed backend instead of running locally:

1. Update your .env file:

   NEXT_PUBLIC_API_URL=https://your-railway-app-url.railway.app

2. Start only the frontend:

   npm run next-dev

Test the API endpoints:

# Health check
curl http://localhost:8000/api/py

# API documentation
curl http://localhost:8000/docs

Test ERC7730 Generation

Try creating metadata for a simple ERC20 contract:

curl -X POST http://localhost:8000/api/py/generateERC7730 \
  -H "Content-Type: application/json" \
  -d '{"address": "0xA0b86a33E6441a8AE8BcBdE39C5eF1F59e2df40", "chain_id": 1}'