Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.84 KB

README.md

File metadata and controls

62 lines (43 loc) · 2.84 KB

NPM Downloads GitHub commit activity GitHub Issues or Pull Requests GitHub Actions Workflow Status

Website Website

Qualcomm UI (QUI)

QUI is a collection of high-quality, reusable UI components that can be used to build beautiful and responsive web applications. It features a cross-framework core layer for unification of styling and behavior, as well as framework adapters for React and Angular.

Branches

main: Primary development branch. Contributors should develop submissions based on this branch, and submit pull requests to this branch.

Requirements

  • Node.js ^20.19.0 || ^22.12.0 || ^24.0.0
  • pnpm
    • Do not install pnpm globally. Use Corepack
    • Use corepack to install the version in the root package.json packageManager field:
      • corepack enable pnpm (you only need to do this once for the version of node that you're using)

Installation Instructions

pnpm i

Usage

  • It's generally a good idea to run pnpm build if you've just pulled from the main branch.
  • pnpm dev will run the dev script in every package except for documentation sites. I recommend using the filter option with ...:
    • pnpm dev --filter @qualcomm-ui/react...
    • pnpm dev --filter @qualcomm-ui/angular...
  • pnpm react-docs dev will start the React documentation site.
  • pnpm angular-docs dev will start the Angular documentation site.
  • pnpm doc-gen will generate the TypeScript JSON documentation for all packages.

Development

TODO: add contribution guidelines

Getting in Contact

License

QUI is licensed under the BSD-3-Clause-Clear License. See LICENSE.txt for the full license text.