react-bootstrap-project-cards v0.1.1

Project Card

Project Card is a React component that displays a card with a title, image, description, and links. It's built using React Bootstrap and Iconify.

Installation

To install the package, run the following command in your project directory:

npm install react-bootstrap-project-card

Usage

Import the component in your project and use it as follows:

import ProjectCard from 'project-card';

const App = () => {
  const links = [
    {
      key: 'Github',
      url: 'https://github.com/mrciolino/portfolio-site',
      icon: 'simple-icons:github',
    },
  ];

  return (
    <ProjectCard
      links={links}
      image="assets/images/portfolio.webp"
      title="Portfolio Website"
      description="The website you are on right now! Check out the source code below."
    />
  );
};

Props

The component accepts the following props: | Prop | Type | Required | Description | |------|------|----------|-------------| | links | Array of objects | Yes | Each object should contain the fields key, url, and icon. key is the display text for the link, url is the URL for the link, and icon is the icon to be displayed next to the link. | | image | String | Yes | Path to the image to be displayed on the card.| | title | String | Yes | Title to be displayed on the card.| | description | String | Yes | Description to be displayed on the card.|

License

Project Card is released under the MIT License.