Decoupled Kit Js

Overview

The Pantheon Systems Decoupled Kits CircleCI is a collection of multiple projects organized by pnpm workspaces. It consists of two main workspaces, starters, and packages, along with a configs workspace and web for documentation. The starters represent different starter kits and are mirrored to standalone repositories at release time. The packages are npm libraries to be published and consumed by the public and the starter kits. To configure the monorepo for development, Node.js, npm, and pnpm should be installed locally.

Features

• Workspaces: The monorepo is organized using pnpm workspaces, with separate workspaces for starters, packages, configs, and documentation.
• Starters: Each directory in the starters workspace represents a starter kit that can be developed against in the monorepo.
• Packages: The monorepo includes npm packages in the packages workspace that are dependencies for the starter kits and can be consumed by the public.
• Configuration: The monorepo includes scripts and configurations for building, testing, and running the projects in the repo.
• Versioning and Releases: The monorepo has mechanisms in place for generating changesets, creating and publishing new versions, and triggering canary releases through CI workflows.
• Bug Reports and Feature Requests: Users can open bug reports or feature requests in the respective repositories.

Installation

1. Install Node.js version 18 LTS. It is recommended to use nvm for managing Node.js versions.
2. Install npm version 9.x.x.
3. Install pnpm version 8.1.0.
4. Clone the repository to your local machine.
5. Install dependencies for all packages and starter kits using the following command:

   npm install
   

6. Run the following command to install husky pre-commit hooks:

   npm run husky:install
   

Summary

The Pantheon Systems Decoupled Kits CircleCI is a collection of projects organized in a monorepo using pnpm workspaces. It includes starter kits, npm packages, configurations, and documentation. Users can contribute to the project by forking and cloning the repository, installing the required dependencies, and using the provided scripts for building, testing, and running the projects. The monorepo also has mechanisms for generating changesets, creating and publishing new versions, and triggering canary releases through CI workflows. Users can report bugs or request new features through the respective repositories.