Skip to content

README.md

Latest commit

 

History

History
95 lines (61 loc) · 1.9 KB

README.md

File metadata and controls

95 lines (61 loc) · 1.9 KB
backdrop

Combat Command: Game Systems

A React component library for the Combat Command application.

Storybook

Installation

npm install @ianpaschal/combat-command-components

Peer Dependencies

This library requires the following peer dependencies:

  • react >= 18.0.0
  • react-dom >= 18.0.0
  • react-router-dom ^7.9.4

Usage

Importing Components

import { AppLogo, AppNavigation, Badge } from '@ianpaschal/combat-command-components';
import '@ianpaschal/combat-command-components/index.css';

Importing Styles

The library provides several style exports:

// Main stylesheet (includes all component styles)
import '@ianpaschal/combat-command-components/index.css';

// CSS variables only
import '@ianpaschal/combat-command-components/styles/variables.css';

// CSS reset only
import '@ianpaschal/combat-command-components/styles/reset.css';

Components

[WIP: See Storybook]

Development

Building

npm run build

Storybook

View components in Storybook:

npm run storybook

Build Storybook for production:

npm run build-storybook

Linting

# TypeScript and ESLint
npm run lint

# SCSS
npm run lint:scss

Generating Type Definitions for SCSS Modules

npm run gen:scss

License

The code in this repository is licensed under the MIT License. See LICENSE for details.

NOTE: "Combat Command" and the Combat Command logo are trademarks of Ian Paschal and are not licensed under the MIT License. Use of these trademarks requires prior written permission. The <AppLogo/> component exists as a means to render the Combat Command logo according to brand guidelines when/where permitted.