Hello World (Code)

This guide walks you through a quick way to get a static HTML, CSS and JavaScript webpage onto the Permaweb using a few lines of code and a command-line interface (CLI).

Requirements

NodeJSopen in new window LTS or greater
Basic knowledge of HTML, CSS and JavaScript
A text editor (VS Code, Sublime, or similar)

Setup

Open up a terminal, and create a new folder called hello-world.

From within the new directory, run the following commands:

npm init -y
mkdir src && cd src
touch index.js index.html style.css

To set up a Node project and create the boilerplate files for creating a website.

Generate a wallet

To upload files to Arweave, you will need an Arweave wallet. Run the following command from within your hello-world directory to generate a wallet:

node -e "require('arweave').init({}).wallets.generate().then(JSON.stringify).then(console.log.bind(console))" > wallet.json

The wallet.json file must be in the root of the hello-world folder and not inside of your src folder.

Create a webpage

This webpage is using basic HTML, CSS and JavaScript to create a styled button that when you click it the header text changes color. Once finished, we will be using permaweb-deploy and our previously generated wallet to deploy a fully functioning, static webpage to Arweave.

Paste the code from the following code blocks into their files:

index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link rel="stylesheet" type="text/css" href="style.css" />
    <script src="index.js"></script>
    <title>Cookbook Hello World!</title>
  </head>

  <body>
    <button onclick="changeColor()" class="button">Click Me!</button>
    <h1 id="main">Hello World!</h1>
  </body>
</html>

style.css

.button {
  padding: "10px";
  background-color: #4caf50;
}

index.js

function changeColor() {
  const header = document.getElementById("main");
  header.style.color === ""
    ? (header.style.color = "red")
    : (header.style.color = "");
}

Now that there is a static site to deploy, you can check it functions as expected by typing open src/index.html in your terminal.

If everything is working as expected, it is time to deploy to Arweave!

Upload using permaweb-deploy

Install and configure permaweb-deploy for deployment:

npm install --save-dev permaweb-deploy

Add a deployment script to your package.json:

{
  "scripts": {
    "deploy": "permaweb-deploy --arns-name my-hello-world --deploy-folder src"
  }
}

Deploy your application:

DEPLOY_KEY=$(base64 -i wallet.json) npm run deploy

For detailed deployment instructions, see Permaweb Deploy.

Congratulations!

You just published a static site on Arweave using a few commands and a few lines of code!

Documentation

# Hello World (Code)

# Requirements

# Setup

# Generate a wallet

# Create a webpage

# index.html

# style.css

# index.js

# Upload using permaweb-deploy

# Congratulations!