Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 1.48 KB

README.md

File metadata and controls

77 lines (57 loc) · 1.48 KB

create-solana-app

A CLI tool to bootstrap Solana projects with customizable package selection.

Prerequisites

  • Node.js >= 20
  • Yarn >= 1.22 (If not installed, run npm install -g yarn)
  • npm >= 9.6.1 (If not installed, run sudo apt-get install npm)
  • Typescript >= 5.5.3 (If not installed, run npm install -g typescript)
  • ts-node >= 10.9.2 (If not installed, run npm install -g ts-node)

Installation

  1. Clone the repository:

    git clone https://github.com/moonboylabsxyz/create-solana-app
    cd create-solana-app
  2. Install dependencies:

    yarn install
  3. Build the project:

    yarn build
  4. Link the package globally:

    yarn link

    And

    sudo npm install -g .

    or

    npm install -g .
    

Usage

Once installed or linked, you can use the CLI tool:

create-solana-app

Follow the prompts to:

  1. Enter your project name
  2. Select the packages you want to install

The CLI will create a new directory with your project name, initialize a new Solana project, and install the selected packages.

Development

After making changes to the source code:

  1. Rebuild the project:

    yarn build
  2. If you've made changes that affect the global command, relink the package:

    yarn unlink
    yarn link

Contributing

This is still in active development, contributions are welcome! Please feel free to submit a PR.

License

MIT