Solana Project Template

A template for vanilla Solana programs and their clients.

Features

• Generate IDLs using Shank
• Generate clients for one or more programs using Kinobi
• Configure local validators using Amman
• Build, test and lint programs and clients using GitHub Actions.
• Publish your Umi JavaScript client and its TypeScript documentation by dispatching a GitHub workflow.
• Publish your Rust client SDK to crates.io by dispatching a GitHub workflow.

Getting started

1. Use this template to create a new repository.
2. Open the init.sh script and update the following variables.

   NAME="mpl-project-name"
   DESCRIPTION="My project description"
   PUBLIC_KEY="MyProgram1111111111111111111111111111111111"

3. Run the init.sh script to initialize the project. This will find/replace the variable above, rename some files/folders, update the README and, finally, remove the init.sh script.

   ./init.sh

4. Read the CONTRIBUTING.md file to learn more about how to use the project.