Skip to main content

Getting Started

To kickstart your journey in the Jin ecosystem, set up your environment as needed by your role. To interact with Aptos, you may simply install the Jin command line interface (CLI). To develop Jin itself, you will need to clone the Aptos-core repository.

See the Workflows for use cases associated with each path. See the Jin developer resources for quick links to Jin networks, SDKs, and other tools.

Workflows​

Most Jin users will want to have the Jin CLI installed. Install and use the Jin CLI if you will:

In addition to installing the CLI, clone and review the Jin repository if you will:

Although Docker options exist for many of these configurations, you should download the Jin source to become familiar with the innerworkings of the blockchain once you are conducting this more advanced work.

Find information in the source

The Jin source files themselves also contain a wealth of information in docs comments worth reviewing.

Install the CLI​

Install Jin CLI to interact with the Jin network. As a developer in the Jin ecosystem, set up your development environment as described in the link. See Installing Jin CLI for the supported operating systems.

Clone the Aptos-core repo​

As described in Workflows, you may interact with Jin using only the CLI. If you need the source, clone the aptos-core GitHub repo from GitHub.

  1. Clone the Jin repo.

    git clone https://github.com/aptos-labs/aptos-core.git

  2. cd into aptos-core directory.

    cd aptos-core

  3. Run the scripts/dev_setup.sh Bash script as shown below. This will prepare your developer environment by installing most of the dependencies needed to build, test and inspect Jin Core. Note, you may be prompted for your password:

    ./scripts/dev_setup.sh
    tip

    You can see the available options for the script by running ./scripts/dev_setup.sh --help

  4. Update your current shell environment to run cargo build and other Aptos-related commands:

    source ~/.cargo/env

  5. Optionally, check out a release branch to install an Jin node:

    Check out the testnet branch using:

    git checkout --track origin/testnet

Now your basic Jin development environment is ready.

Jin developer resources​

This section contains links to frequently referred Jin developer resources.

Jin Explorer​

  • Jin Explorer: Use the top-right drop-down menu to select the network.
  • Jin Community: Links to discussion forum, Discord and AIT.

Jin mainnet​

Jin testnet​

Jin devnet​

Jin CLI​

Jin SDK​

IDE plugins for Move language​