Skip to content

Zyrenth/Quantum

Repository files navigation


Quantum Logo

GitHub stars GitHub issues GitHub pull requests

GitHub license Built with

Warning

The project is currently in alpha and things may change rapidly, please report any issues you may find. Contributions are greatly appreciated.

What is Quantum?

Quantum is a collection of components with a CLI tool for building React applications faster by providing already exisitng components. They are built with React and are currently tested with Next.js. The CLI tool is used to manage the components for your React application.

What can the CLI do?

  • 🚀 Manage components from one or multiple remote repositories:
    • 🔄 Automatically handle dependencies.
  • 🎨 Generate a color palette from a provided list of colors:
    • 🖌️ Integrate the palette into components automatically.
    • 🔄 Regenerate the palette as needed.
  • 🌐 Use custom remote repositories outside of the Quantum project:
    • 🔐 Support custom headers for authentication.
  • Cache remote contents for faster access.
  • And much more!

Temporary CLI Installation

Since the CLI is not yet published to npm, you can install it locally by first cloning the repository and then running the following commands:

cd cli
pnpm install
pnpm build
pnpm link --global

If you have done this correctly, you should be able to run the quantum-cli command in your terminal.

Documentation

Contributing

If you would like to contribute to the project, please see the CONTRIBUTING.md file for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Releases

No releases published

Packages

No packages published

Languages