Quickstart

Deploy your first application to the permaweb in under 5 minutes using ARlink. This guide will walk you through connecting your wallet, setting up your first deployment, and publishing your application.

Prerequisites

Before you begin, make sure you have:

• An Arweave wallet (ArConnect recommended)

• A GitHub account or Protocol Land account

• Your web application code ready to deploy

Step 1: Connect Your Wallet

1. Visit ARlink Dashboard

2. Click "Connect Wallet" in the top right corner

3. Select your wallet provider (ArConnect recommended)

4. Authorize the connection when prompted

If you don't have an Arweave wallet yet, we recommend installing ArConnect first.

Step 2: Create Your First Deployment

Choose your preferred deployment method:

GitHub Deploy

1. Click "New Deployment" in the dashboard

2. Select "Import from GitHub"

3. Authorize ARlink in GitHub if prompted

4. Choose your repository

5. Configure your build settings:

   Project Name: my-first-app
   Branch: main
   Install Command: npm ci  # or yarn install
   Build Command: npm run build  # or yarn build
   Output Directory: dist  # or build

Protocol Land Deploy

1. Click "New Deployment" in the dashboard

2. Select "Import from Protocol Land"

3. Choose your repository from the list

4. Configure your build settings:

   Project Name: my-first-app
   Install Command: npm ci  # or yarn install
   Build Command: npm run build  # or yarn build
   Output Directory: dist  # or build

Step 3: Set Up Your Domain

Choose your preferred domain option:

Custom ArNS Name

1. Enable "Custom ArNS Name" in deployment settings

2. Enter your preferred name (e.g., myapp)

3. Your application will be available at: myapp_arlink.ar-io.dev

Custom names must be unique across ARlink. If your chosen name is taken, try adding a unique identifier.

Existing ArNS

1. Enable "Use Existing ArNS" in deployment settings

2. Select your ArNS name from the dropdown

3. Confirm the connection

You must own or control the ArNS name to use this option.

Step 4: Deploy

1. Review your deployment settings

2. Click "Deploy" to start the build process

3. Monitor the build progress in real-time

4. Once complete, you'll receive:

   • Arweave Transaction ID

   • Deployment URL

   • ArNS Domain (if configured)

What happens during deployment?

1. Your code is cloned from the repository

2. Dependencies are installed using your specified install command

3. Application is built using your build command

4. Built files are bundled and uploaded to Arweave

5. ArNS records are updated (if configured)

6. Your application becomes available on the permaweb

Common Questions

How much does deployment cost?

Deployment costs are free for the duration of the PermaHacks and the Arweave FullStack Hackathon!

How long does deployment take?

Most deployments complete in 2-5 minutes. Factors affecting deployment time:

• Repository size

• Build complexity

• Network conditions

• Arweave network speed

What are the size limits?

• Maximum build output: 10MB

• Build timeout: 10 minutes

• For larger applications, consider:

  • Optimizing assets

  • Using lazy loading

  • Implementing code splitting

Next Steps

Need help? Click the chat icon in the bottom right or join our Discord community.