https://github.com/standardweb3/signac

Signac is a development environment to compile, deploy, test, and debug your Polkadot software. Get ink! contract deployed in multichain ecosystem
https://github.com/standardweb3/signac

Last synced: about 1 year ago
JSON representation

Signac is a development environment to compile, deploy, test, and debug your Polkadot software. Get ink! contract deployed in multichain ecosystem

• Host: GitHub
• URL: https://github.com/standardweb3/signac
• Owner: standardweb3
• License: apache-2.0
• Created: 2022-07-12T10:44:45.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T05:57:31.000Z (over 3 years ago)
• Last Synced: 2025-04-10T12:57:03.184Z (about 1 year ago)
• Language: TypeScript
• Size: 49.6 MB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Signac

![](https://raw.githubusercontent.com/standardweb3/signac/main/media/signac_logo.png)

---

![Proudly built for Ink!](https://raw.githubusercontent.com/paritytech/ink/bb4104ec423c34ff863d8d2eb619f10f4962b570/.images/built-for-ink.svg)

*Signac is a development environment to compile, deploy, test, and debug your unstoppable apps. Get ink! contract deployed in unstoppable app ecosystem.*

## Getting started

- :book: Try quickstart tutorial for Ink! smart contract development in [documentation]()

- :question: Ask question in our [Discord](https://discord.gg/v2HeWgsfhz)

## Prerequisites

- :gear: [NodeJS](https://nodejs.org/) 

- :crab: [Rust](https://www.rust-lang.org/)

- 🧰 [Yarn](https://yarnpkg.com/)/[Nx](https://nx.dev)/[Cargo Contract](https://github.com/paritytech/cargo-contract)

###### Developer Quickstart:

```bash

yarn bootstrap

node ./dist/packages/core/src/index.js --help

```

## Architecture Overview

- :package: This mono-repository contains a suite of smart contract framework.

- :balance_scale: The mono-repository is released under [Apache 2.0 license](./LICENSE). Note, that the packages contain their own licenses.

| Package        | Version                                                                                             | License                                                                                                              | Docs                                                                             | Description                                 |

|----------------|-----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|---------------------------------------------|

| @signac/core   | [![npm](https://img.shields.io/npm/v/@signac/core)](https://www.npmjs.com/package/@signac/core)     | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | [![documentation](https://img.shields.io/badge/readme-blue)](./packages/core)    | Core CLI package of Signac framework        |

| @signac/init   | [![npm](https://img.shields.io/npm/v/@signac/init)](https://www.npmjs.com/package/@signac/init)     | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | [![documentation](https://img.shields.io/badge/readme-blue) ](./packages/init)   | Initializes Signac smart contract framework |

| @signac/config | [![npm](https://img.shields.io/npm/v/@signac/config)](https://www.npmjs.com/package/@signac/config) | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | [![documentation](https://img.shields.io/badge/readme-blue) ](./packages/config) | Configuration utility for Signac framework  |

| @signac/events | [![npm](https://img.shields.io/npm/v/@signac/config)](https://www.npmjs.com/package/@signac/events) | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | [![documentation](https://img.shields.io/badge/readme-blue) ](./packages/events) | Event emitter for Signac framework          |

| @signac/error  | [![npm](https://img.shields.io/npm/v/@signac/error)](https://www.npmjs.com/package/@signac/error)   | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | [![documentation](https://img.shields.io/badge/readme-blue) ](./packages/error)  | Error handler for Signac framework          |

| nxink          | [![npm](https://img.shields.io/npm/v/nxink)](https://www.npmjs.com/package/nxink)                   | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | [![documentation](https://img.shields.io/badge/readme-blue) ](./packages/nxink)  | Nx plugin which is used in the workspace    |

## Contributors

Read our [contributors document](https://github.com/standardweb3/signac/blob/main/CONTRIBUTING.md), [submit an issue](https://github.com/standardweb3/signac/issues/new/choose) or talk to us on our [Discord](https://discord.gg/qw9PZEavCC)!