Skip to content

project44/manifest

Repository files navigation

Manifest Design System

Manifest Design System is the open source implementation of the project44 design language, used to build consistent, accessible and delightful products at project44. While the design language is closed source, the technology is open and contributions are welcomed and encouraged.

Bundle Size LICENSE npm latest package CI PRs Welcome

Documentation

For usage guidelines and full documentation please visit our documentation website.

Getting Started

Please refer the individual packages READMEs for installation and usage instructions.

Install Turborepo

Manifest uses Turborepo as it's build system and repo management tool. We suggest installing Turborepo globally with npm:

npm install -g turborepo

Install dependencies and build turbo repository

yarn && yarn build

Run a command

Once Turborepo is installed, the following commands are available:

Command Purpose
yarn build Builds all projects.
yarn format:write Format all projects.
yarn format Check formatting on all projects.
yarn lint:write Lints all projects.
yarn lint Lints linting in all projects.
yarn test Runs test in all projects.
yarn typecheck Type checks all projects.

Tasks can all be run on individual apps - you can view a list of available project by running

yarn workspaces list
yarn workspace <subapp-name> <command>

Project structure

  1. Apps - Contains Storybook and Manifest documentation website.
  2. Packages - All typescript code that is intended to be used as a package and consumed by client applications.

Contributing

Contributions are always welcome!! Please review our Contribution Guide to get started.

License

Licensed under the MIT.