Git Product home page Git Product logo

create-stacks-cli's Introduction

Create Stacks App CLI

The Create Stacks App CLI is a powerful command-line tool designed to streamline the process of initializing a new Stacks blockchain application. With support for various frameworks and customization options, it allows developers to quickly scaffold projects tailored to their needs.

Features

  • Support for multiple JavaScript frameworks (React, Vue, Svelte, Next.js, Vite).

  • Optional TypeScript support.

  • Integration with Stacks blockchain features, including smart contracts.

  • Customizable project templates for both frontend and backend development.

Installation

Usage

Options

The CLI supports several flags to customize the project:

  • --bun, --yarn, --pnpm, --npm: Specify the package manager to use for installing dependencies. Defaults to npm if no flag is provided.

  • --no-backend or --no-contracts: Skip generating backend templates and dependencies.

  • --react, --vue, --svelte, --next, --vite: Choose the JavaScript framework for the frontend. If no framework is specified, a basic template is used.

  • --typescript or --ts: Enable TypeScript for the project.

What Gets Generated

Depending on the options selected, the CLI will generate a project structure with the following:

  • Frontend Template: Based on the chosen framework (React, Vue, Svelte, Next.js, Vite), including necessary configuration files and a basic starting template. TypeScript configuration is included if the --typescript flag is used.

  • Smart Contracts: If not skipped, smart contracts are included unless the --no-contracts option is used. Requires clarinet installation.

  • Package Manager: Dependencies are installed using the specified package manager (npm, yarn, pnpm, or bun), and a package.json file is configured accordingly.

After the project is generated, the CLI will provide instructions for getting started with development.

create-stacks-cli's People

Contributors

ryanwaits avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.