ArDrive Docs

# ArDrive Price Calculator

# Overview

The ArDrive Price Calculator website (opens new window) is open source, and its code can be viewed here (opens new window)

This website is intended to calculate the cost, in a wide variety of denominations and cryptocurrencies, of uploading data to Arweave. You can spin up your own version by cloning the code from Github and following these steps.

# Developer Setup

Follow these steps to get the developer environment up and running:

# Install Yarn 2

The ArDrive Price Calculator uses Yarn 2, so install the latest version with the yarn installation instructions (opens new window). In most cases:

# Brew:
brew install yarn

# Or with NPM:
npm install -g yarn

We also use husky to manage the git commit hooks that help to improve the quality of our commits. Without installing husky, you risk committing non-compliant code to the repository.

Using husky triggers two pre-commit hooks. The first will run lint-staged on each staged file, which includes running prettier to format, eslint for linting, and also tsc-files for quickly checking that TypeScript can compile the code. The second hook will test the codebase prior to committing, ensuring that all tests must pass.

To enable hooks locally, you will need to run:

yarn husky install

# NVM

This repository uses NVM and an .nvmrc file to lock the Node version to the current version used by ardrive-core-js.

Note for Windows: We recommend using WSL for setting up NVM on Windows using the instructions described here (opens new window)

Follow these steps to get NVM up and running on your system:

  1. Install NVM using these installation instructions (opens new window).
  2. Navigate to this project's root directory
  3. Ensure that the correct version of Node is installed by performing: nvm install
  4. Every time you start a new terminal session or switch to this project from another NPM project, you should set the correct version of Node by running: nvm use

To ensure your environment is compatible, we also recommend the following VSCode extensions:

# Available Scripts

# yarn start

Runs the app in the development mode. Open http://localhost:8080 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

# yarn build

Builds a static copy of your site to the build/ folder. Your app is ready to be deployed!

# yarn test

Launches the application test runner. Run with the --watch flag (yarn test -- --watch) to run in interactive watch mode.

# yarn run:prod

Builds a fresh snowpack production build to the build/ folder Then launches that copy with http-server-spa for local testing The build will be available for preview at: http://localhost:8080 (opens new window)