The Regimen Contractus of Aetheris Nova is the vault to the schemas that enact the will of the Aetherii.

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

The repo follows the following structure:

.
├─ packages
│   ├── <package>
│   │   ├── .lintstagedrc.mjs
│   │   ├── .releaserc        <-- semantic release configuration
│   │   ├── LICENSE
│   │   ├── package.json      <-- contains package dependencies and is used to run package-level scripts
│   │   ├── README.md
│   │   └── ...
│   └── ...                   <-- other packages
├── package.json              <-- root package.json that contains top-level dependencies and tools
└── ...

The root package.json utilizes pnpm's workspace feature. The root package.json should only reference packages that are used at the root level or are utilities/tools.

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

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

• .lintstagedrc.mjs - Scripts to run on the pre-commit hook. This file is REQUIRED, however, if there are no scripts to run, use an empty file.
• .releaserc - The local semantic-release configuration.
• LICENSE - The license for the package.
• package.json - The license for the package.
• README.md - Contains installation and usage instructions relevant to the package.

• Install Node v20.18.0+ (LTS as of 9th November 2024)
• Install pnpm v8+
• Install Foundry

^{Back to top ^}

1. Install the dependencies using:

pnpm install

^{Back to top ^}

^{Back to top ^}

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

^{Back to top ^}