cardano-rosetta

(โ˜… 97)

An implementation of Rosetta for Cardano

  • .gitignore
  • .versionrc
  • bors.toml
  • CODE-OF-CONDUCT.md
  • CONTRIBUTING.md
  • default.nix
  • Dockerfile
  • ecosystem.config.js
  • flake.lock
  • flake.nix
  • LICENSE.md
  • package-lock.json
  • package.json
  • postgresql.conf
  • README.md
  • release.nix
  • shell.nix
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/cardano-foundation/cardano-rosetta

Downloads the entire project code from GitHub to your computer.

cd cardano-rosetta

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build \

Builds a runnable image based on the Dockerfile.

docker run \

Runs the built image as an actual container.

docker stop cardano-rosetta && \

Type this command into your terminal and run it.

docker rm cardano-rosetta && \

Type this command into your terminal and run it.

docker run --rm -v cardano-rosetta:/data ubuntu rm -rf /data/postgresql /data/db-sync

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd cardano-rosetta-server

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation