https://github.com/veeso/ic-canister-template

A template for implementing IC canisters
https://github.com/veeso/ic-canister-template

Last synced: 3 days ago
JSON representation

A template for implementing IC canisters

• Host: GitHub
• URL: https://github.com/veeso/ic-canister-template
• Owner: veeso
• License: mit
• Created: 2025-04-19T09:41:29.000Z (9 days ago)
• Default Branch: main
• Last Pushed: 2025-04-22T20:36:49.000Z (6 days ago)
• Last Synced: 2025-04-25T15:26:55.235Z (3 days ago)
• Language: Rust
• Size: 32.2 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IC Canister Template

[![license-mit](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/license/mit/)

[![ci state](https://github.com/veeso/ic-canister-template/actions/workflows/ci.yml/badge.svg)](https://github.com/veeso/ic-canister-template/actions/workflows/ci.yml)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

A template for building Internet Computer canisters with Rust.

## Get Started

### Prerequisites

- [Rust (1.85 or later)](https://rustup.rs/): to build the canisters

- [DFX](https://internetcomputer.org/docs/building-apps/getting-started/install) (v0.23 or later)

- [Just](https://just.systems/) to run scripts

- [ic-wasm](https://github.com/dfinity/ic-wasm): to bundle the canisters

- [candid-extractor](https://github.com/dfinity/candid-extractor): to extract the candid interface of the canisters

### Build canisters

Just run the following command to build all canisters:

```sh

just build_all_canisters

```

### Test canisters

To run the tests, run the following command:

```sh

just test [test_name]

just integration_test [test_name]

```

### Lint and format

```sh

just clippy

just fmt_nightly

```

## License

This project is licensed under the [MIT License](LICENSE).