Merge branch 'main' into snyk-upgrade-aeda3d61202823cc3782bdb424773ef7

README.md

@@ -1,17 +1,45 @@
 # mui-mas
 
-The SHAES Farm Material UI-based component library
+A Material UI-based component library for SHAES Farm's applications.
 
 [![build status](https://github.com/shaes-farm/mui-mas/actions/workflows/build-n-test.yml/badge.svg)](https://github.com/shaes-farm/mui-mas/actions/workflows/build-n-test.yml)
 [![coverage status](https://coveralls.io/repos/github/shaes-farm/mui-mas/badge.svg?branch=main)](https://coveralls.io/github/shaes-farm/mui-mas?branch=main)
 [![vulnerabilities](https://snyk.io/test/github/shaes-farm/mui-mas/badge.svg)](https://snyk.io/test/github/shaes-farm/mui-mas)
+[![npm version](https://badge.fury.io/js/@shaes-farm%2Fmui-mas.svg)](https://badge.fury.io/js/@shaes-farm%2Fmui-mas)
 
-## Motivation
-
-In Spanish "mui mas" means "much more", and that is what we provide in this component library; much more than your basic set of Material UI components. We have spent years developing enterprise applications, and we've used that experience to develop an opinionated set of MUI components that allow us to quickly construct functionality common to most enterprise applications. With <code>mui-mas</code> we can scaffold an app in minutes, instead of hours, or days. Get professional looking enterprise applications quickly, customized to your workflows.
+[![https://nodei.co/npm/@shaes-farm/mui-mas.png?downloads=true&downloadRank=true&stars=true](https://nodei.co/npm/@shaes-farm/mui-mas.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/@shaes-farm/mui-mas)
 
 ## Getting Started
 
+This package is intended for use by SHAES Farm's applications to ease the integration of our platform requirements. We currently use the following technology stack in our application suite:
+
+- [React](https://react.dev/)
+- [Next.js 13+](https://nextjs.org/)
+- [Supabase](https://supabase.com/)
+- [Material UI](https://mui.com/material-ui/)
+
 <pre>
-$ npm install @shaes-farm/mui-mas
+$ pnpm create next-app myapp \
+    --app \
+    --eslint \
+    --src-dir \
+    --typescript \
+    --use-pnpm
+  ...
+$ cd myapp
+$ pnpm add @shaes-farm/mui-mas
 </pre>
+
+## Motivation
+
+In Spanish "mui mas" means "much more", and that's what we've built with this component library; much more than the basic set of Material UI components.
+
+We've developed an opinionated set of React components based on MUI that allow us to construct functionality needed by our applications, integrated with MUI, Supabase, and Next. With <code>mui-mas</code> we can scaffold an app in minutes, instead of hours, and get functional applications more quickly, customized to our workflows.
+
+## Early Release
+
+We are releasing <code>mui mas</code> as an open-source component library because others may find it useful to quickly build high-quality applications. However, these components are customized for our design system and our back-end systems, and they may not be generally applicable for your needs. We've decided to release the library in this state as an Alpha release to gather feedback and to see if others find a library such as this useful.
+
+## Help Us Improve
+
+You can help us make this library better by submitting pull requests with suggestions. Show us how you would make the library more modular and better able to support a wider choice of use cases. Ideas, suggestions, and critical reviews are all welcomed as we continue to improve this package for our own needs.

package.json

@@ -23,7 +23,7 @@
     "verify": "npm run lint && npm run lint:ts && npm test",
     "storybook": "env STORYBOOK_DISABLE_TELEMETRY=1 storybook dev -p 6006",
     "build-storybook": "storybook build",
-    "prepublish": "tsc"
+    "prepublish": "npm run verify"
   },
   "repository": {
     "type": "git",
@@ -39,10 +39,17 @@
     "url": "https://github.com/shaes-farm/mui-mas/issues"
   },
   "homepage": "https://github.com/shaes-farm/mui-mas#readme",
+  "peerDependencies": {
+    "@mui/material": "^5.14.1",
+    "next": "^13.0.0",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0"
+  },
   "devDependencies": {
     "@babel/preset-env": "7.22.2",
     "@babel/preset-react": "7.22.3",
     "@babel/preset-typescript": "7.21.5",
+    "@faker-js/faker": "^8.0.2",
     "@storybook/addon-essentials": "7.2.0",
     "@storybook/addon-interactions": "7.2.0",
     "@storybook/addon-links": "7.2.0",
@@ -54,14 +61,12 @@
     "@storybook/testing-library": "0.2.0",
     "@testing-library/react": "14.0.0",
     "@testing-library/user-event": "14.4.3",
-    "@types/chance": "1.1.3",
     "@types/jest": "29.5.1",
     "@types/react": "18.0.25",
     "@types/react-dom": "18.0.8",
     "@typescript-eslint/eslint-plugin": "5.61.0",
     "@typescript-eslint/parser": "5.61.0",
     "babel-jest": "29.5.0",
-    "chance": "1.1.11",
     "eslint": "8.44.0",
     "eslint-config-standard-with-typescript": "36.0.0",
     "eslint-plugin-import": "2.27.5",
@@ -89,8 +94,8 @@
     "@supabase/auth-helpers-react": "0.4.0",
     "@supabase/supabase-js": "2.26.0",
     "clsx": "1.2.1",
-    "next": "13.2.4",
-    "react": "18.2.0",
-    "react-dom": "18.2.0"
+    "next": "^13.0.0",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0"
   }
 }