README.md

Checkpoint starter template

This is a template to quickly get started to use Checkpoint to expose a GraphQL API to query data from your Starknet contracts.

Getting started

This starter project contains logic to index events from a Starknet Poster contract that is defined in the starknet-poster repository.

Create a copy of this repository by clicking 'Use this template' button or clicking this link.

Requirements

• Node.js (>= 16.x.x)
• Docker with docker-compose
• Yarn

You can also use NPM, just make sure to replace the subsequent 'yarn' commands with their NPM equivalent.

After cloning this project, run the following command to install dependencies:

yarn # or 'npm install'

Next, you'll need a MySQL server running and a connection string available as environment variable DATABASE_URL. You can use docker-compose to set up default MySQL server in container:

docker-compose up -d

For local development, you can create a .env file from the .env.example file and the application will read the values on startup.

Next, start up the server:

yarn dev # for local development or else `yarn start` for production build.

This will expose a GraphQL API endpoint locally at http://localhost:3000. You can easily interact with this endpoint using the GraphiQL interface by visiting http://localhost:3000 in your browser.

To fetch a list of Post's try the following query:

query {
  posts {
    id
    author
    content
    tag
    created_at_block
    created_at
    tx_hash
  }
}

To learn more about the different ways you can query the GraphQL API, visit the Checkpoint documentation here.

License

MIT