/qUIck-react

simple easy to use component library to make your development faster.

Primary LanguageTypeScriptMIT LicenseMIT

qᏌ𝕚𝒄k-𝖗𝔢𝒂ct Atom Symbol

A simple component library for blazing-fast website development

Getting StartedTesting Your CodeContributingLicense

Rocket Getting Started

  1. Fork the Repository: Begin by forking this repository to your own GitHub account.

  2. Clone your Repository: Clone your forked repository URL to your local machine using this command:

    git clone <your-cloned-repo-url>
    
  3. Navigate to the Project Directory: Change your working directory to the qUIck-React folder:

    cd qUIck-React
    
  4. Install Packages: Install the necessary packages by running:

    npm install
    

    Note: Ensure you have Prettier installed globally with Node.js using npm i -g prettier.

Check Mark Button Testing Your Code

  1. Build Components: Compile the qUIck-React components by running:

    npm run build
    
  2. Create a React Project: Set up a new React project outside of qUIck-React.

  3. Install qUIck-React: Add qUIck-React as a dependency in your React project using the path to your component library.

  4. Import Components: Import the qUIck-React components you wish to test in your project.

  5. Run Your React Project: Start your React project with either of these commands:

    npm run dev
    

    or

    npm start
    

Handshake Contributing to the Project

  1. Check Existing Issues: Explore the existing issues to find tasks that match your skills and interests.

  2. Share Your Ideas: If you have new ideas or feature suggestions, create an issue to initiate a discussion.

  3. Assigned Issues: If an issue is assigned to you, start working on it right away.

  4. Create a Pull Request (PR): Once you've finished coding, create a Pull Request.

  5. Await Merging: Be patient and await review and merging by the project maintainers.

Scroll Contributing Guidelines

Before you start contributing to qUIck-React, please read our Contributing Guidelines to understand how you can contribute effectively. Your contributions are highly valued, and we aim for excellence together.

Handshake Code of Conduct

Our community upholds a strict Code of Conduct to maintain a warm and inclusive environment for all. Please familiarize yourself with our code of conduct before engaging in discussions or contributing.

Page Facing Up License

qUIck-React is licensed under the MIT License. You can find the full terms and conditions for use, reproduction, and distribution in the LICENSE file.


Man Mechanic Repo Maintainers Man Mechanic

Dhruv Dabhi
Dhruv Dabhi
Hitarth Patel
Hitarth Patel
Kris Patel
Kris Patel
Shaily Fadadu
Shaily Fadadu

Glowing Star Meet Our Awesome Contributors Glowing Star

Thank you to all the contributors for your invaluable contributions! 🎉