README.md

Kibisis Pinakion Token

The monorepo that contains the smart contracts and clients for the official Kibisis Pinakion NFT.

Table Of Contents

• 1. Overview
  • 1.1. Monorepo Project Structure
• 2. Getting Started
  • 2.1. Requirements
  • 2.2. Installation
• 3. Appendix
  • 3.1. Packages
  • 3.2. Useful Commands
• 4. How To Contribute
• 5. License

🗂️ 1. Overview

1.1. Monorepo Project Structure

The repo follows the following structure:

.
├─ packages
│   ├── <package>
│   │   ├── .releaserc       <-- semantic release configuration
│   │   ├── README.md
│   │   └── ...
│   └── ...                  <-- other packages
├── COPYING                  <-- blanket and fallback license
├── package.json             <-- root package.json that contains top-level dependencies and scripts
└── ...

Root package.json

The root package.json utilizes npm's workspace feature. The root package.json should only reference packages that are used at the root level and within scripts.

It is RECOMMENDED that the root package.json be used to run the npm scripts (e.g. build, lint, test) for each package.

packages/ Directory

The packages/ directory contains, as the name suggests, the packages of the monorepo.

packages/<package> Directory

Each package SHOULD reflect the name of the package, i.e. the packages/pinakionclient/ and SHOULD contain the following files and directories:

• .releaserc - the local semantic-release configuration.
• README.md - Contains installation and usage instructions relevant to the package.

Each package MAY also have the following files/directories:

• LICENSE/COPYING - A package specific license. If none is specified, it will fallback to license specified in the COPYING file.

🪄 2. Getting Started

2.1. Requirements

• Install Node v20.18.0+ (LTS as of 9th November 2024)
• Install npm v8+
• Install AlgoKit v2+

^{Back to top ^}

2.2. Installation

1. Install the dependencies using:

npm install

^{Back to top ^}

📑 3. Appendix

3.1. Packages

Name	Description
contract	The Kibisis Pinakion NFT contract written in TEALScript.
js-client	The JS client to interact with the Kibisis Pinakion NFT contract.

^{Back to top ^}

3.2. Useful Commands

Command	Description
npm run build:<package>	Builds the named package.
npm run lint:<package>	Lints the named package.
npm run prettier	Runs prettier with the same configuration that is run on the pre-commit hooks.
npm run test:<package>	Runs the named package's tests.

^{Back to top ^}

👏 4. How To Contribute

Please read the Contributing Guide to learn about the development process.

^{Back to top ^}

📄 5. License

Please refer to the packages COPYING file.

^{Back to top ^}