npm - jcicl - Versions diffs - 0.0.9 → 0.0.11 - Mend

jcicl 0.0.9 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

package/dist/README.md ADDED Viewed

@@ -0,0 +1,99 @@
+# Welcome to the Johnson County Component Library!
+## Usage
+### Runtime Enviromnent
+1. Please download and install [NVM for Windows](https://github.com/coreybutler/nvm-windows?tab=readme-ov-file)
+2. Run `nvm install 20.18.0` to install the current LTS version of node
+3. Run `nvm use 20`
+### Quick Start
+#### Usage within an existing React project
+To add the Johnson County Component Library to your React project, from the root directory of your project, please run `npm install jccomponentlibrary`
+### Add the fonts
+```console
+npm install @fontsource/roboto
+npm install @fontsource/material-icons
+npm install @mui/icons-material
+```
+Then, in your project entry (most likely `main.tsx`) point, add:
+```js
+import '@fontsource/roboto/300.css';
+import '@fontsource/roboto/400.css';
+import '@fontsource/roboto/500.css';
+import '@fontsource/roboto/700.css';
+import '@fontsource/material-icons';
+```
+Alternatively, add to project root `index.html` `<head />`:
+```html
+<link rel="preconnect" href="https://fonts.googleapis.com" />
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" />
+```
+**After installation, import any components you wish to use: `import { Component } from jccomponentlibrary`**
+#### Viewing Storybook Documentation
+We are using [Storybook](https://storybook.js.org/docs/get-started/frameworks/react-vite?renderer=react) to document our component library
+Please use `npm run storybook` or `npm start` from the root directory to start the storybook application. You can see helpful documentation links under the `Configure your project` section of the Storybook application.
+## Development
+### Getting started
+[Please ensure your react development environment is set up](https://devops.jc.net/JCIT/Business%20Solutions%20Delivery/_wiki/wikis/Business-Solutions-Delivery.wiki?wikiVersion=GBwikiMaster&pagePath=%2FSetting%20Up%20React&pageId=219).
+From the root project directory, please run `npm install`
+### Dependencies
+For this component library, we are extending [Material UI](https://mui.com/material-ui/getting-started/) and customizing with [Emotion/Styled](https://emotion.sh/docs/styled)
+### Components Directory Structure
+In each components folder, you should see a `[Component].stories.tsx` file. You can copy the established pattern to create stories for new components, or customize as you please according to the above documentation
+#### Base
+Base components are intended to be the foundational building blocks of our web pages here at Johnson County
+#### Composite
+Composite components are intended to be reusable chunks of HTML built from base components and complimentary TSX (TypeScript XML)
+#### Superomposite
+Composite with a higher level of complexity
+#### Templates
+Templates are intended to render the HTML for predefined page layouts comprised of composite components, base components, and complimentary TSX
+#### **All of the above component types are inteded to be importable and reusable throughout the suite of Johnson County web applications** 😊
+### Process
+1. Add or update any components you wish. For new components, please create the associated `[NewComponent].stories.tsx` file to allow for documentation. In `.storybook/main.ts`, we are using the default string matching pattern to automatically index `*.stories.*` files 😊
+2. Export any newly created components in the relevant index files: `(base/(super)composite/templates)/[NewComponent]/index.ts`, `(base/(super)composite/templates)/index.ts`, and `components/index.ts`. `src/index.ts`, the entry point for our complied library, automatically exports everything from `components/index.ts`
+3. Publish the library and update relevant project dependencies
+### Publishing the library
+**TODO: Automate this process on merges to master**
+1. Please increment the version number in `package.json`
+2. Build the library with `npm run build`
+3. Publish the library with `npm publish`

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "jcicl",
   "private": false,
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Component library for the websites of Johnson County Iowa",
   "license": "MIT",
   "homepage": "https://devops.jc.net/JCIT/Business%20Solutions%20Delivery/_git/JCComponentLibrary?path=%2FREADME.md&version=GBmaster",
@@ -14,6 +14,9 @@
   },
   "type": "module",
   "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
   "exports": {
     ".": "./index.js",
     "./**/*": "./**/*.js"
@@ -23,10 +26,13 @@
   "scripts": {
     "start": "storybook dev -p 7007",
     "updateVersion": "npm version patch --no-git-tag-update --force",
+    "up": "npm run updateVersion && npm publish",
     "build": "tsc -b && vite build",
     "postbuild": "shx cp package.json dist/package.json && shx cp README.md dist/README.md",
     "push": "npm publish ./dist",
     "bp": "npm run updateVersion && npm run build && npm run postbuild && npm run push",
+    "bpMinor": "npm version minor --no-git-tag-update --force && npm run build && npm run postbuild && npm run push",
+    "bpMajor": "npm version major --no-git-tag-update --force && npm run build && npm run postbuild && npm run push",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --check .",