Skip to content
This repository has been archived by the owner on Dec 13, 2022. It is now read-only.

Latest commit

 

History

History
102 lines (63 loc) · 2.4 KB

README.md

File metadata and controls

102 lines (63 loc) · 2.4 KB
Raw

License

Vartex is a vortex into the permaweb -- the decentralised web on top of the Arweave protocol. Vartex nodes offer services to permaweb users -- serving data and query requests to desktop and mobile browsers.

The service builds upon Amplify, a fork of the original Arweave.net gateway service.

Current Release: BETA-2

We are in beta! Please give Vartex a spin and let us know what you think via the Arweave Developer Discord.

  • 👻 If you encounter issues, please open a ticket here and we will try to respond ASAP!
  • 🎁 If you feel this code needs improvement, please open a PR.
  • 🙏 If a feature you'd like to see is missing, open a feature request ticket and let's discuss it!

Running with Docker Compose

The easiest way to start with your own gateway is by running the service with docker-compose.

Requirements

  • Docker Compose (comes with Cassandra image)
  • 1TB or more free disk space for persistent volume

Running

Clone this repo with:

git clone https://github.com/ArweaveTeam/vartex.git

Go into the directory:

cd gateway-cassandra

Copy the .env.example to .env, and change the ARWEAVE_NODES variable to the IP addresses of your Arweave node.

cp .env.example .env

Run the docker-compose command:

docker-compose up -d

Wait a couple of minutes and then you can see your gateway running on:

http://localhost:3000/graphql

Run without Docker

You can also run the gateway without using Docker.

Requirements

  • NodeJS v16.4.0 or higher
  • Cassandra v4.0.0 or higher

Environment

By default, there is a default environment you can use located at .env.example in the repository.

Make sure you copy this configuration to .env.

cp .env.example .env

Compilation

Start Cassandra and then run the following command to compile the gateway.

# with npm
npm run start

# with yarn
yarn start

Endpoints

You can test if the server and the GraphQL queries are working properly by navigating to.

http://localhost:1248/graphql

This webpage should look similar to.

https://arweave.dev/graphql