npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ost-cas-fee-adv-23-24/design-system-component-library-team-batman

v1.22.0

Published

Design System Component Library

Downloads

66

Readme

npm

Project: Design System Component Library

This project is a design system component library built with React, TypeScript & Tailwind.
It is a project for the CAS Frontend Engineering Advanced course at the OST. The goal of this project is to create a design system component library that can be used in other projects.

Folder Structure

💻 Stack

  • ⚛️ react: JavaScript library for building user interfaces.
  • next: React framework for server-side rendering, static site generation, and more.
  • 🎨 tailwindcss: Utility-first CSS framework for rapidly building custom designs.
  • 📘 typescript: Typed superset of JavaScript that compiles to plain JavaScript.
  • 📚 storybook: UI development environment and component library for building, documenting, and testing UI components.
  • ⚙️ @headlessui/react: Completely unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS.
  • 🔧 tailwind-merge: Tailwind CSS plugin for merging utilities.
  • 🔗 clsx: Tiny utility for constructing className strings conditionally.
  • 🚀 framer-motion: Production-ready animation library for React.
  • 👮 eslint: Pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
  • ✏️ prettier: Opinionated code formatter that enforces a consistent code style.

📝 Project Summary

  • src: Main source directory containing all the project's components and utilities.
  • src/docs: Directory for Storybook's documentation files.
  • src/utils: Directory for utility functions.
  • src/components: Directory for reusable UI components.

🚀 Run Locally

  1. Clone the design-system-component-library-team-batman repository:
git clone https://github.com/ost-cas-fee-adv-23-24/design-system-component-library-team-batman
  1. Install the dependencies with one of the package managers listed below:
npm install
  1. Start the development mode:
npm run storybook
  1. Open http://localhost:6006 with your browser to see the result.

💡 Tipp

Don't forget to install the recommended extensions for vscode .vscode/extensions.json

🚀 Build package

npm run build

Output will be in the dist folder.

🚀 Install package

install package from npm

npm i @ost-cas-fee-adv-23-24/design-system-component-library-team-batman

🚀 Usage

To use the components styles, you have 3 Options:

  • Option 1: import the minified css file in your project.
import '@ost-cas-fee-adv-23-24/design-system-component-library-team-batman/style.css';
module.exports = {
  presets: [require('@ost-cas-fee-adv-23-24/design-system-component-library-team-batman/tailwind.config.ts')],

  // ... rest of your config
};
module.exports = {
  content: [
    // ...
    './node_modules/@ost-cas-fee-adv-23-24/design-system-component-library-team-batman/dist/**/*.{js,ts,jsx,tsx}',
  ],
  // ... rest of your config
};

🎉 after that you can use the components in your project. 🎉

import { Button } from '@ost-cas-fee-adv-23-24/design-system-component-library-team-batman';

const App = () => {
  return <Button>Click me</Button>;
};

💡 Next.js Server Components

Next.js 13 introduces a new app/ directory structure. By default it uses Server Components. As some of our components use React hooks, we added in those cases the "use client"; tag, so you can import them directly in your React Server Components (RSC).

🙌 Maintainers (Team Batman)

📄 License

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