create-clarity-starter
TypeScript icon, indicating that this package has built-in type declarations

0.3.15 • Public • Published

create-clarity-starter

A Clarity development environment generator, usable as an npm init initializer.

Generates a TypeScript project that contains a hello-world.clar sample smart contract and a minimal Mocha test suite using the Clarity SDK.

Quick Start

Generate a project

npm init clarity-starter my-proj
cd my-proj

Replace my-proj with your app name. The app directory is created if it does not already exist.

Run tests:

npm test

Expected output:

  hello world contract test suite
    ✓ should have a valid syntax
    deploying an instance of the contract
      ✓ should return 'hello world'
      ✓ should echo number

  3 passing

Troubleshooting

Project Generator

The package is a thin wrapper around the yeoman based Clarity app generator package. Initializers for use with npm init require a package with the naming scheme create-<initializer>.

  • Alternate install commands

    Using the yo generator

    npm install -g yo generator-clarity-dev
    yo clarity-dev
    

    See generator-clarity-dev for more details.

    Using npx directly

    npx create-clarity-starter
    

clarity-native-bin

If seeing error messages related to the clarity-native-bin package then see its README for more details.

Package Sidebar

Install

npm i create-clarity-starter

Weekly Downloads

0

Version

0.3.15

License

MIT

Unpacked Size

7.36 kB

Total Files

11

Last publish

Collaborators

  • ablankstein
  • zone117x
  • hstove
  • kyranjamie
  • aulneau
  • jcnelson
  • yknl
  • reedrosenbluth
  • blockstack-devops