Code Monkey home page Code Monkey logo

arweave-custom-hashrouting's Introduction

Arweave Multipage Website Starter Kit

This starter kit provides a foundation for creating multipage websites with custom hash routing, utilizing a recursive Svelte component, and featuring basic custom Vite configuration for seamless deployment to the Arweave Mainnet.

Features

  • Multipage functionality through custom hash routing (not reliant on any additional packages like tinro or Reach Router)
  • A Recursive Svelte Component
  • Basic custom Vite configuration for easy deployment to Arweave Mainnet

Requirements

  • Customize the page(s) however you want, just keep the entire build under 100kb. (Run npm run build to see build size)
  • No $AR token or even an Arweave wallet is required as long as you keep the build under 100kb.

Pros & Cons

Pros:

  • Extremely simple to use and implement.
  • No need to use any additional packages like tinro or Reach Router.
  • Very easy to update the website with basic text-based content.
  • Very easy to update the CSS.
  • Using basic Javascript and Svelte.

Cons:

  • For free deployment, you need to keep the build under 100kb, which restricts the amount of content and styling you can deploy.
  • This style of hashrouting may be difficult to manage for those unfamiliar with it.
  • Many may find editing the content beyond the basic text-based content to be difficult.

Usage

  1. Clone the Repository:
git clone https://github.com/PSkinnerTech/Arweave-Custom-HashRouting.git
  1. Navigate to the Project Directory:
cd Arweave-Custom-Hashrouting
  1. Install Dependencies:
npm install
  1. Customize Your Website:

    • Edit the pages as per your requirements.
  2. Build Your Website:

npm run build
  1. Deploy to Arweave:
arkb deploy dist --use-bundler https://node2.bundlr.network --tag-name DEPLOY --tag-value Your-MultiPage-AppName --auto-confirm

Note: Replace Your-MultiPage-AppName with the name of your multipage application.

An Arweave URL will be printed when the deployment is successful. It may take up to 30 seconds for the content to publish to the link, so please be patient.

You're all set! Congrats!

HMU if you have questions. @PSkinnerTech

arweave-custom-hashrouting's People

Watchers

Patrick Skinner avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.