This package provides a set of tools and components for document engineering within the Powerhouse ecosystem.
# Using npm
npm install @powerhousedao/document-engineering
# Using yarn
yarn add @powerhousedao/document-engineering
# Using pnpm
pnpm add @powerhousedao/document-engineeringThe package provides several entry points for different use cases:
import { ... } from '@powerhousedao/document-engineering';import { ... } from '@powerhousedao/document-engineering/ui';For data manipulation and transformation utilities:
import { ... } from '@powerhousedao/document-engineering/scalars';For GraphQL related utilities and schema definitions:
import { ... } from '@powerhousedao/document-engineering/graphql';To include the package's styles:
import '@powerhousedao/document-engineering/style.css';This package uses the Inter font family. You must include it in your HTML <head> section:
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />The preconnect links optimize font loading performance by establishing early connections to Google Fonts servers.
Within the project, the following import maps are available:
#assets- Assets utilities and components#scalars- Scalar transformations and utilities#ui- UI components#graphql- GraphQL related utilities
- Node.js (LTS version)
- pnpm
# Install dependencies
pnpm install
# Run storybook for development
pnpm storybook
# Build the package
pnpm build# Run tests
pnpm test
# Run tests in watch mode
pnpm test:watchThis project uses semantic-release for versioning. Commit messages should follow the Conventional Commits specification.
Release channels:
mainbranch - Latest stable releasestagingbranch - Pre-release with staging tagdevbranch - Development pre-release
To make a commit using the conventional format:
pnpm commitAGPL-3.0-only